jazzy 0.0.20 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/.gitmodules +6 -3
  3. data/.travis.yml +1 -1
  4. data/CHANGELOG.md +23 -1
  5. data/Gemfile.lock +41 -5
  6. data/Rakefile +21 -0
  7. data/jazzy.gemspec +1 -0
  8. data/lib/jazzy/assets/css/jazzy.css.scss +26 -0
  9. data/lib/jazzy/config.rb +29 -0
  10. data/lib/jazzy/doc_builder.rb +17 -9
  11. data/lib/jazzy/docset_builder.rb +13 -4
  12. data/lib/jazzy/gem_version.rb +1 -1
  13. data/lib/jazzy/jazzy_markdown.rb +2 -1
  14. data/lib/jazzy/podspec_documenter.rb +109 -0
  15. data/lib/jazzy/readme_generator.rb +33 -6
  16. data/lib/jazzy/sourcekitten.rb +15 -2
  17. data/lib/jazzy/sourcekitten/Commandant.framework/Commandant +0 -0
  18. data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Commandant +0 -0
  19. data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftdoc +0 -0
  20. data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftmodule +0 -0
  21. data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/module.modulemap +10 -0
  22. data/{spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures → lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Resources}/Info.plist +21 -7
  23. data/lib/jazzy/sourcekitten/LlamaKit.framework/LlamaKit +0 -0
  24. data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/LlamaKit +0 -0
  25. data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftdoc +0 -0
  26. data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftmodule +0 -0
  27. data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/module.modulemap +10 -0
  28. data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Resources/Info.plist +47 -0
  29. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/SourceKittenFramework +0 -0
  30. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/SwiftXPC +0 -0
  31. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftdoc +0 -0
  32. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftmodule +0 -0
  33. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/module.modulemap +10 -0
  34. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist +42 -0
  35. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/SwiftXPC +0 -0
  36. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib +0 -0
  37. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib +0 -0
  38. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib +0 -0
  39. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib +0 -0
  40. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib +0 -0
  41. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib +0 -0
  42. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftSecurity.dylib +0 -0
  43. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftdoc +0 -0
  44. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftmodule +0 -0
  45. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/module.modulemap +10 -0
  46. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Resources/Info.plist +42 -0
  47. data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/SourceKittenFramework +0 -0
  48. data/lib/jazzy/sourcekitten/sourcekitten +0 -0
  49. data/spec/integration_spec.rb +6 -0
  50. metadata +50 -122
  51. data/bin/sourcekitten +0 -0
  52. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +0 -268
  53. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +0 -488
  54. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +0 -842
  55. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +0 -258
  56. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +0 -383
  57. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +0 -703
  58. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +0 -345
  59. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +0 -369
  60. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +0 -1041
  61. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +0 -227
  62. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +0 -276
  63. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +0 -228
  64. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +0 -228
  65. data/spec/integration_specs/document_alamofire/after/docs/css/highlight.css +0 -202
  66. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +0 -708
  67. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Info.plist +0 -20
  68. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes.html +0 -268
  69. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/Manager.html +0 -488
  70. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html +0 -842
  71. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Enums.html +0 -258
  72. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Enums/ParameterEncoding.html +0 -383
  73. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions.html +0 -703
  74. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions/Manager.html +0 -345
  75. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions/Request.html +0 -369
  76. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html +0 -1041
  77. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Global Variables.html +0 -227
  78. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Manager.html +0 -345
  79. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/ParameterEncoding.html +0 -383
  80. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols.html +0 -276
  81. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols/URLRequestConvertible.html +0 -228
  82. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html +0 -228
  83. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Request.html +0 -369
  84. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/URLRequestConvertible.html +0 -228
  85. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/URLStringConvertible.html +0 -228
  86. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/carat.png +0 -0
  87. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/css/highlight.css +0 -202
  88. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/css/jazzy.css +0 -708
  89. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/dash.png +0 -0
  90. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/gh.png +0 -0
  91. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/highlight.css +0 -202
  92. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/carat.png +0 -0
  93. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/dash.png +0 -0
  94. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/gh.png +0 -0
  95. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html +0 -756
  96. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jazzy.css +0 -708
  97. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jazzy.js +0 -21
  98. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jquery.min.js +0 -4
  99. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js +0 -21
  100. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js +0 -4
  101. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/undocumented.txt +0 -18
  102. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/docSet.dsidx.csv +0 -80
  103. data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.xml +0 -1
  104. data/spec/integration_specs/document_alamofire/after/docs/img/carat.png +0 -0
  105. data/spec/integration_specs/document_alamofire/after/docs/img/dash.png +0 -0
  106. data/spec/integration_specs/document_alamofire/after/docs/img/gh.png +0 -0
  107. data/spec/integration_specs/document_alamofire/after/docs/index.html +0 -756
  108. data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +0 -21
  109. data/spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js +0 -4
  110. data/spec/integration_specs/document_alamofire/after/docs/undocumented.txt +0 -18
  111. data/spec/integration_specs/document_alamofire/after/execution_output.txt +0 -5
  112. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +0 -333
  113. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +0 -149
  114. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +0 -171
  115. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +0 -149
  116. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +0 -152
  117. data/spec/integration_specs/misc_jazzy_features/after/docs/css/highlight.css +0 -202
  118. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +0 -708
  119. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Info.plist +0 -20
  120. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes.html +0 -333
  121. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +0 -149
  122. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/DocumentedEnum.html +0 -149
  123. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums.html +0 -171
  124. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +0 -149
  125. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Global Variables.html +0 -152
  126. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/ImplicitlyInternalTopLevelClass.html +0 -149
  127. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/carat.png +0 -0
  128. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/highlight.css +0 -202
  129. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/jazzy.css +0 -708
  130. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/dash.png +0 -0
  131. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/gh.png +0 -0
  132. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/highlight.css +0 -202
  133. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/carat.png +0 -0
  134. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/dash.png +0 -0
  135. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/gh.png +0 -0
  136. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +0 -112
  137. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.css +0 -708
  138. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.js +0 -21
  139. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js +0 -4
  140. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js +0 -21
  141. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js +0 -4
  142. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/undocumented.txt +0 -3
  143. data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +0 -17
  144. data/spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png +0 -0
  145. data/spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png +0 -0
  146. data/spec/integration_specs/misc_jazzy_features/after/docs/img/gh.png +0 -0
  147. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +0 -112
  148. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +0 -21
  149. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js +0 -4
  150. data/spec/integration_specs/misc_jazzy_features/after/docs/undocumented.txt +0 -3
  151. data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +0 -5
  152. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj +0 -293
  153. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.xcworkspace/contents.xcworkspacedata +0 -7
  154. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +0 -60
  155. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/MiscJazzyFeatures.h +0 -10
  156. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes.html +0 -317
  157. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes/ImplicitlyInternalTopLevelClass.html +0 -138
  158. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums.html +0 -155
  159. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums/DocumentedEnum.html +0 -128
  160. data/spec/integration_specs/misc_jazzy_features/before/docs/Global Variables.html +0 -138
  161. data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +0 -609
  162. data/spec/integration_specs/misc_jazzy_features/before/docs/img/carat.png +0 -0
  163. data/spec/integration_specs/misc_jazzy_features/before/docs/img/dash.png +0 -0
  164. data/spec/integration_specs/misc_jazzy_features/before/docs/img/gh.png +0 -0
  165. data/spec/integration_specs/misc_jazzy_features/before/docs/index.html +0 -99
  166. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jazzy.js +0 -15
  167. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jquery.min.js +0 -4
data/spec/integration_specs/document_alamofire/after/docs/Functions.html DELETED
@@ -1,1041 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <title>Functions 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 title="Functions Reference"></a>
24
- <header>
25
- <div class="content-wrapper">
26
- <p class="header-text"><a href="index.html">Alamofire Docs</a> (83% documented)</p>
27
- <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>
28
- <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>
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
- Functions 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/Manager.html">Manager</a>
78
- </li>
79
- <li class="nav-chapter">
80
- <a href="Extensions/Manager.html">Manager</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.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
87
- </li>
88
- <li class="nav-chapter">
89
- <a href="Extensions.html#/s:C9Alamofire7Request">Request</a>
90
- </li>
91
- <li class="nav-chapter">
92
- <a href="Extensions/Request.html">Request</a>
93
- </li>
94
- <li class="nav-chapter">
95
- <a href="Extensions/Request.html">Request</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.html#/s:SS">String</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:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
122
- </li>
123
- <li class="nav-chapter">
124
- <a href="Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
125
- </li>
126
- <li class="nav-chapter">
127
- <a href="Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
128
- </li>
129
- <li class="nav-chapter">
130
- <a href="Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
131
- </li>
132
- <li class="nav-chapter">
133
- <a href="Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</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:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
140
- </li>
141
- <li class="nav-chapter">
142
- <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
143
- </li>
144
- <li class="nav-chapter">
145
- <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
146
- </li>
147
- <li class="nav-chapter">
148
- <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
149
- </li>
150
- <li class="nav-chapter">
151
- <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</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/URLRequestConvertible.html">URLRequestConvertible</a>
160
- </li>
161
- <li class="nav-chapter">
162
- <a href="Protocols/URLStringConvertible.html">URLStringConvertible</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">Functions</h1>
173
- <section>
174
- <section class="section">
175
- <p class="para">The following functions are available globally.</p>
176
- </section>
177
- <section class="section task-group-section">
178
- <div class="task-group">
179
- <div class="task-name-container">
180
- <hr/>
181
- <a name="/Request"></a>
182
- <a name="//apple_ref/swift/Section/Request" class="dashAnchor"></a>
183
- <a href="#/Request">
184
- <h3 class="section-name">Request</h3>
185
- </a>
186
-
187
- </div>
188
- <ul class="task-group-list">
189
- <li class="item symbol">
190
- <div class="task-group-term">
191
- <code>
192
- <a name="/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">
193
- <a name="//apple_ref/swift/Function/request(_:_:parameters:encoding:)" class="dashAnchor"></a>
194
- <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
195
- </code>
196
- </div>
197
- <div class="height-container">
198
- <div class="pointy-thing-container"></div>
199
- <section class="section instance-method">
200
- <div class="pointy-thing"></div>
201
- <div class="abstract">
202
- <p class="para">Creates a request using the shared manager instance for the specified method, URL string, parameters, and parameter encoding.</p>
203
- </div>
204
- <div class="declaration">
205
- <h4>Declaration</h4>
206
-
207
- <div class="Swift">
208
- <p class="aside-title">Swift</p>
209
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</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="kc">nil</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="o">.</span><span class="kt">URL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
210
-
211
- </div>
212
- </div>
213
- <div class="parameters">
214
- <h4>Parameters</h4>
215
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
216
- <tbody>
217
- <tr>
218
- <td scope="row">
219
- <code>
220
- <em class="term">method</em>
221
- </code>
222
- </td>
223
- <td>
224
- <div class="definition">
225
- <p class="para">The HTTP method.</p>
226
- </div>
227
- </td>
228
- </tr>
229
- <tr>
230
- <td scope="row">
231
- <code>
232
- <em class="term">URLString</em>
233
- </code>
234
- </td>
235
- <td>
236
- <div class="definition">
237
- <p class="para">The URL string.</p>
238
- </div>
239
- </td>
240
- </tr>
241
- <tr>
242
- <td scope="row">
243
- <code>
244
- <em class="term">parameters</em>
245
- </code>
246
- </td>
247
- <td>
248
- <div class="definition">
249
- <p class="para">The parameters. <code>nil</code> by default.</p>
250
- </div>
251
- </td>
252
- </tr>
253
- <tr>
254
- <td scope="row">
255
- <code>
256
- <em class="term">encoding</em>
257
- </code>
258
- </td>
259
- <td>
260
- <div class="definition">
261
- <p class="para">The parameter encoding. <code>.URL</code> by default.</p>
262
- </div>
263
- </td>
264
- </tr>
265
- </tbody>
266
- </table>
267
- </div>
268
- <div class="result-description">
269
- <h4>Return Value</h4>
270
- <p class="para">The created request.</p>
271
- </div>
272
- <div class="result-description view-on-github">
273
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1461">Show on GitHub</a>
274
- </div>
275
- </section>
276
- </div>
277
- </li>
278
- <li class="item symbol">
279
- <div class="task-group-term">
280
- <code>
281
- <a name="/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">
282
- <a name="//apple_ref/swift/Function/request(_:)" class="dashAnchor"></a>
283
- <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
284
- </code>
285
- </div>
286
- <div class="height-container">
287
- <div class="pointy-thing-container"></div>
288
- <section class="section instance-method">
289
- <div class="pointy-thing"></div>
290
- <div class="abstract">
291
- <p class="para">Creates a request using the shared manager instance for the specified URL request.If <code>startRequestsImmediately</code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
292
- </div>
293
- <div class="declaration">
294
- <h4>Declaration</h4>
295
-
296
- <div class="Swift">
297
- <p class="aside-title">Swift</p>
298
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</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="o">-&gt;</span> <span class="kt">Request</span></code></pre>
299
-
300
- </div>
301
- </div>
302
- <div class="parameters">
303
- <h4>Parameters</h4>
304
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
305
- <tbody>
306
- <tr>
307
- <td scope="row">
308
- <code>
309
- <em class="term">URLRequest</em>
310
- </code>
311
- </td>
312
- <td>
313
- <div class="definition">
314
- <p class="para">The URL request</p>
315
- </div>
316
- </td>
317
- </tr>
318
- </tbody>
319
- </table>
320
- </div>
321
- <div class="result-description">
322
- <h4>Return Value</h4>
323
- <p class="para">The created request.</p>
324
- </div>
325
- <div class="result-description view-on-github">
326
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1474">Show on GitHub</a>
327
- </div>
328
- </section>
329
- </div>
330
- </li>
331
- </ul>
332
- </div>
333
- <div class="task-group">
334
- <div class="task-name-container">
335
-
336
- <a name="/File"></a>
337
- <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
338
- <a href="#/File">
339
- <h3 class="section-name">File</h3>
340
- </a>
341
-
342
- </div>
343
- <ul class="task-group-list">
344
- <li class="item symbol">
345
- <div class="task-group-term">
346
- <code>
347
- <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">
348
- <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
349
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
350
- </code>
351
- </div>
352
- <div class="height-container">
353
- <div class="pointy-thing-container"></div>
354
- <section class="section instance-method">
355
- <div class="pointy-thing"></div>
356
- <div class="abstract">
357
- <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and file.</p>
358
- </div>
359
- <div class="declaration">
360
- <h4>Declaration</h4>
361
-
362
- <div class="Swift">
363
- <p class="aside-title">Swift</p>
364
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
365
-
366
- </div>
367
- </div>
368
- <div class="parameters">
369
- <h4>Parameters</h4>
370
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
371
- <tbody>
372
- <tr>
373
- <td scope="row">
374
- <code>
375
- <em class="term">method</em>
376
- </code>
377
- </td>
378
- <td>
379
- <div class="definition">
380
- <p class="para">The HTTP method.</p>
381
- </div>
382
- </td>
383
- </tr>
384
- <tr>
385
- <td scope="row">
386
- <code>
387
- <em class="term">URLString</em>
388
- </code>
389
- </td>
390
- <td>
391
- <div class="definition">
392
- <p class="para">The URL string.</p>
393
- </div>
394
- </td>
395
- </tr>
396
- <tr>
397
- <td scope="row">
398
- <code>
399
- <em class="term">file</em>
400
- </code>
401
- </td>
402
- <td>
403
- <div class="definition">
404
- <p class="para">The file to upload.</p>
405
- </div>
406
- </td>
407
- </tr>
408
- </tbody>
409
- </table>
410
- </div>
411
- <div class="result-description">
412
- <h4>Return Value</h4>
413
- <p class="para">The created upload request.</p>
414
- </div>
415
- <div class="result-description view-on-github">
416
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1491">Show on GitHub</a>
417
- </div>
418
- </section>
419
- </div>
420
- </li>
421
- <li class="item symbol">
422
- <div class="task-group-term">
423
- <code>
424
- <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">
425
- <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
426
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
427
- </code>
428
- </div>
429
- <div class="height-container">
430
- <div class="pointy-thing-container"></div>
431
- <section class="section instance-method">
432
- <div class="pointy-thing"></div>
433
- <div class="abstract">
434
- <p class="para">Creates an upload request using the shared manager instance for the specified URL request and file.</p>
435
- </div>
436
- <div class="declaration">
437
- <h4>Declaration</h4>
438
-
439
- <div class="Swift">
440
- <p class="aside-title">Swift</p>
441
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</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">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
442
-
443
- </div>
444
- </div>
445
- <div class="parameters">
446
- <h4>Parameters</h4>
447
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
448
- <tbody>
449
- <tr>
450
- <td scope="row">
451
- <code>
452
- <em class="term">URLRequest</em>
453
- </code>
454
- </td>
455
- <td>
456
- <div class="definition">
457
- <p class="para">The URL request.</p>
458
- </div>
459
- </td>
460
- </tr>
461
- <tr>
462
- <td scope="row">
463
- <code>
464
- <em class="term">file</em>
465
- </code>
466
- </td>
467
- <td>
468
- <div class="definition">
469
- <p class="para">The file to upload.</p>
470
- </div>
471
- </td>
472
- </tr>
473
- </tbody>
474
- </table>
475
- </div>
476
- <div class="result-description">
477
- <h4>Return Value</h4>
478
- <p class="para">The created upload request.</p>
479
- </div>
480
- <div class="result-description view-on-github">
481
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1503">Show on GitHub</a>
482
- </div>
483
- </section>
484
- </div>
485
- </li>
486
- </ul>
487
- </div>
488
- <div class="task-group">
489
- <div class="task-name-container">
490
-
491
- <a name="/Data"></a>
492
- <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
493
- <a href="#/Data">
494
- <h3 class="section-name">Data</h3>
495
- </a>
496
-
497
- </div>
498
- <ul class="task-group-list">
499
- <li class="item symbol">
500
- <div class="task-group-term">
501
- <code>
502
- <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">
503
- <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
504
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
505
- </code>
506
- </div>
507
- <div class="height-container">
508
- <div class="pointy-thing-container"></div>
509
- <section class="section instance-method">
510
- <div class="pointy-thing"></div>
511
- <div class="abstract">
512
- <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and data.</p>
513
- </div>
514
- <div class="declaration">
515
- <h4>Declaration</h4>
516
-
517
- <div class="Swift">
518
- <p class="aside-title">Swift</p>
519
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
520
-
521
- </div>
522
- </div>
523
- <div class="parameters">
524
- <h4>Parameters</h4>
525
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
526
- <tbody>
527
- <tr>
528
- <td scope="row">
529
- <code>
530
- <em class="term">method</em>
531
- </code>
532
- </td>
533
- <td>
534
- <div class="definition">
535
- <p class="para">The HTTP method.</p>
536
- </div>
537
- </td>
538
- </tr>
539
- <tr>
540
- <td scope="row">
541
- <code>
542
- <em class="term">URLString</em>
543
- </code>
544
- </td>
545
- <td>
546
- <div class="definition">
547
- <p class="para">The URL string.</p>
548
- </div>
549
- </td>
550
- </tr>
551
- <tr>
552
- <td scope="row">
553
- <code>
554
- <em class="term">data</em>
555
- </code>
556
- </td>
557
- <td>
558
- <div class="definition">
559
- <p class="para">The data to upload.</p>
560
- </div>
561
- </td>
562
- </tr>
563
- </tbody>
564
- </table>
565
- </div>
566
- <div class="result-description">
567
- <h4>Return Value</h4>
568
- <p class="para">The created upload request.</p>
569
- </div>
570
- <div class="result-description view-on-github">
571
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1518">Show on GitHub</a>
572
- </div>
573
- </section>
574
- </div>
575
- </li>
576
- <li class="item symbol">
577
- <div class="task-group-term">
578
- <code>
579
- <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">
580
- <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
581
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</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 an upload request using the shared manager instance for the specified URL request and data.</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">func</span> <span class="nf">upload</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">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
597
-
598
- </div>
599
- </div>
600
- <div class="parameters">
601
- <h4>Parameters</h4>
602
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
603
- <tbody>
604
- <tr>
605
- <td scope="row">
606
- <code>
607
- <em class="term">URLRequest</em>
608
- </code>
609
- </td>
610
- <td>
611
- <div class="definition">
612
- <p class="para">The URL request.</p>
613
- </div>
614
- </td>
615
- </tr>
616
- <tr>
617
- <td scope="row">
618
- <code>
619
- <em class="term">data</em>
620
- </code>
621
- </td>
622
- <td>
623
- <div class="definition">
624
- <p class="para">The data to upload.</p>
625
- </div>
626
- </td>
627
- </tr>
628
- </tbody>
629
- </table>
630
- </div>
631
- <div class="result-description">
632
- <h4>Return Value</h4>
633
- <p class="para">The created upload request.</p>
634
- </div>
635
- <div class="result-description view-on-github">
636
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1530">Show on GitHub</a>
637
- </div>
638
- </section>
639
- </div>
640
- </li>
641
- </ul>
642
- </div>
643
- <div class="task-group">
644
- <div class="task-name-container">
645
-
646
- <a name="/Stream"></a>
647
- <a name="//apple_ref/swift/Section/Stream" class="dashAnchor"></a>
648
- <a href="#/Stream">
649
- <h3 class="section-name">Stream</h3>
650
- </a>
651
-
652
- </div>
653
- <ul class="task-group-list">
654
- <li class="item symbol">
655
- <div class="task-group-term">
656
- <code>
657
- <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">
658
- <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
659
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
660
- </code>
661
- </div>
662
- <div class="height-container">
663
- <div class="pointy-thing-container"></div>
664
- <section class="section instance-method">
665
- <div class="pointy-thing"></div>
666
- <div class="abstract">
667
- <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and stream.</p>
668
- </div>
669
- <div class="declaration">
670
- <h4>Declaration</h4>
671
-
672
- <div class="Swift">
673
- <p class="aside-title">Swift</p>
674
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
675
-
676
- </div>
677
- </div>
678
- <div class="parameters">
679
- <h4>Parameters</h4>
680
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
681
- <tbody>
682
- <tr>
683
- <td scope="row">
684
- <code>
685
- <em class="term">method</em>
686
- </code>
687
- </td>
688
- <td>
689
- <div class="definition">
690
- <p class="para">The HTTP method.</p>
691
- </div>
692
- </td>
693
- </tr>
694
- <tr>
695
- <td scope="row">
696
- <code>
697
- <em class="term">URLString</em>
698
- </code>
699
- </td>
700
- <td>
701
- <div class="definition">
702
- <p class="para">The URL string.</p>
703
- </div>
704
- </td>
705
- </tr>
706
- <tr>
707
- <td scope="row">
708
- <code>
709
- <em class="term">stream</em>
710
- </code>
711
- </td>
712
- <td>
713
- <div class="definition">
714
- <p class="para">The stream to upload.</p>
715
- </div>
716
- </td>
717
- </tr>
718
- </tbody>
719
- </table>
720
- </div>
721
- <div class="result-description">
722
- <h4>Return Value</h4>
723
- <p class="para">The created upload request.</p>
724
- </div>
725
- <div class="result-description view-on-github">
726
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1545">Show on GitHub</a>
727
- </div>
728
- </section>
729
- </div>
730
- </li>
731
- <li class="item symbol">
732
- <div class="task-group-term">
733
- <code>
734
- <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">
735
- <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
736
- <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
737
- </code>
738
- </div>
739
- <div class="height-container">
740
- <div class="pointy-thing-container"></div>
741
- <section class="section instance-method">
742
- <div class="pointy-thing"></div>
743
- <div class="abstract">
744
- <p class="para">Creates an upload request using the shared manager instance for the specified URL request and stream.</p>
745
- </div>
746
- <div class="declaration">
747
- <h4>Declaration</h4>
748
-
749
- <div class="Swift">
750
- <p class="aside-title">Swift</p>
751
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</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">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
752
-
753
- </div>
754
- </div>
755
- <div class="parameters">
756
- <h4>Parameters</h4>
757
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
758
- <tbody>
759
- <tr>
760
- <td scope="row">
761
- <code>
762
- <em class="term">URLRequest</em>
763
- </code>
764
- </td>
765
- <td>
766
- <div class="definition">
767
- <p class="para">The URL request.</p>
768
- </div>
769
- </td>
770
- </tr>
771
- <tr>
772
- <td scope="row">
773
- <code>
774
- <em class="term">stream</em>
775
- </code>
776
- </td>
777
- <td>
778
- <div class="definition">
779
- <p class="para">The stream to upload.</p>
780
- </div>
781
- </td>
782
- </tr>
783
- </tbody>
784
- </table>
785
- </div>
786
- <div class="result-description">
787
- <h4>Return Value</h4>
788
- <p class="para">The created upload request.</p>
789
- </div>
790
- <div class="result-description view-on-github">
791
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1557">Show on GitHub</a>
792
- </div>
793
- </section>
794
- </div>
795
- </li>
796
- </ul>
797
- </div>
798
- <div class="task-group">
799
- <div class="task-name-container">
800
-
801
- <a name="/URL%20Request"></a>
802
- <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
803
- <a href="#/URL%20Request">
804
- <h3 class="section-name">URL Request</h3>
805
- </a>
806
-
807
- </div>
808
- <ul class="task-group-list">
809
- <li class="item symbol">
810
- <div class="task-group-term">
811
- <code>
812
- <a name="/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
813
- <a name="//apple_ref/swift/Function/download(_:_:_:)" class="dashAnchor"></a>
814
- <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
815
- </code>
816
- </div>
817
- <div class="height-container">
818
- <div class="pointy-thing-container"></div>
819
- <section class="section instance-method">
820
- <div class="pointy-thing"></div>
821
- <div class="abstract">
822
- <p class="para">Creates a download request using the shared manager instance for the specified method and URL string.</p>
823
- </div>
824
- <div class="declaration">
825
- <h4>Declaration</h4>
826
-
827
- <div class="Swift">
828
- <p class="aside-title">Swift</p>
829
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
830
-
831
- </div>
832
- </div>
833
- <div class="parameters">
834
- <h4>Parameters</h4>
835
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
836
- <tbody>
837
- <tr>
838
- <td scope="row">
839
- <code>
840
- <em class="term">method</em>
841
- </code>
842
- </td>
843
- <td>
844
- <div class="definition">
845
- <p class="para">The HTTP method.</p>
846
- </div>
847
- </td>
848
- </tr>
849
- <tr>
850
- <td scope="row">
851
- <code>
852
- <em class="term">URLString</em>
853
- </code>
854
- </td>
855
- <td>
856
- <div class="definition">
857
- <p class="para">The URL string.</p>
858
- </div>
859
- </td>
860
- </tr>
861
- <tr>
862
- <td scope="row">
863
- <code>
864
- <em class="term">destination</em>
865
- </code>
866
- </td>
867
- <td>
868
- <div class="definition">
869
- <p class="para">The closure used to determine the destination of the downloaded file.</p>
870
- </div>
871
- </td>
872
- </tr>
873
- </tbody>
874
- </table>
875
- </div>
876
- <div class="result-description">
877
- <h4>Return Value</h4>
878
- <p class="para">The created download request.</p>
879
- </div>
880
- <div class="result-description view-on-github">
881
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1574">Show on GitHub</a>
882
- </div>
883
- </section>
884
- </div>
885
- </li>
886
- <li class="item symbol">
887
- <div class="task-group-term">
888
- <code>
889
- <a name="/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
890
- <a name="//apple_ref/swift/Function/download(_:_:)" class="dashAnchor"></a>
891
- <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
892
- </code>
893
- </div>
894
- <div class="height-container">
895
- <div class="pointy-thing-container"></div>
896
- <section class="section instance-method">
897
- <div class="pointy-thing"></div>
898
- <div class="abstract">
899
- <p class="para">Creates a download request using the shared manager instance for the specified URL request.</p>
900
- </div>
901
- <div class="declaration">
902
- <h4>Declaration</h4>
903
-
904
- <div class="Swift">
905
- <p class="aside-title">Swift</p>
906
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</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">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
907
-
908
- </div>
909
- </div>
910
- <div class="parameters">
911
- <h4>Parameters</h4>
912
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
913
- <tbody>
914
- <tr>
915
- <td scope="row">
916
- <code>
917
- <em class="term">URLRequest</em>
918
- </code>
919
- </td>
920
- <td>
921
- <div class="definition">
922
- <p class="para">The URL request.</p>
923
- </div>
924
- </td>
925
- </tr>
926
- <tr>
927
- <td scope="row">
928
- <code>
929
- <em class="term">destination</em>
930
- </code>
931
- </td>
932
- <td>
933
- <div class="definition">
934
- <p class="para">The closure used to determine the destination of the downloaded file.</p>
935
- </div>
936
- </td>
937
- </tr>
938
- </tbody>
939
- </table>
940
- </div>
941
- <div class="result-description">
942
- <h4>Return Value</h4>
943
- <p class="para">The created download request.</p>
944
- </div>
945
- <div class="result-description view-on-github">
946
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1586">Show on GitHub</a>
947
- </div>
948
- </section>
949
- </div>
950
- </li>
951
- </ul>
952
- </div>
953
- <div class="task-group">
954
- <div class="task-name-container">
955
-
956
- <a name="/Resume%20Data"></a>
957
- <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
958
- <a href="#/Resume%20Data">
959
- <h3 class="section-name">Resume Data</h3>
960
- </a>
961
-
962
- </div>
963
- <ul class="task-group-list">
964
- <li class="item symbol">
965
- <div class="task-group-term">
966
- <code>
967
- <a name="/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
968
- <a name="//apple_ref/swift/Function/download(resumeData:_:)" class="dashAnchor"></a>
969
- <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
970
- </code>
971
- </div>
972
- <div class="height-container">
973
- <div class="pointy-thing-container"></div>
974
- <section class="section instance-method">
975
- <div class="pointy-thing"></div>
976
- <div class="abstract">
977
- <p class="para">Creates a request using the shared manager instance for downloading from the resume data produced from a previous request cancellation.</p>
978
- </div>
979
- <div class="declaration">
980
- <h4>Declaration</h4>
981
-
982
- <div class="Swift">
983
- <p class="aside-title">Swift</p>
984
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
985
-
986
- </div>
987
- </div>
988
- <div class="parameters">
989
- <h4>Parameters</h4>
990
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
991
- <tbody>
992
- <tr>
993
- <td scope="row">
994
- <code>
995
- <em class="term">resumeData</em>
996
- </code>
997
- </td>
998
- <td>
999
- <div class="definition">
1000
- <p class="para">The resume data. This is an opaque data blob produced by <code>NSURLSessionDownloadTask</code> when a task is cancelled. See <code>NSURLSession -downloadTaskWithResumeData:</code> for additional information.</p>
1001
- </div>
1002
- </td>
1003
- </tr>
1004
- <tr>
1005
- <td scope="row">
1006
- <code>
1007
- <em class="term">destination</em>
1008
- </code>
1009
- </td>
1010
- <td>
1011
- <div class="definition">
1012
- <p class="para">The closure used to determine the destination of the downloaded file.</p>
1013
- </div>
1014
- </td>
1015
- </tr>
1016
- </tbody>
1017
- </table>
1018
- </div>
1019
- <div class="result-description">
1020
- <h4>Return Value</h4>
1021
- <p class="para">The created download request.</p>
1022
- </div>
1023
- <div class="result-description view-on-github">
1024
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1600">Show on GitHub</a>
1025
- </div>
1026
- </section>
1027
- </div>
1028
- </li>
1029
- </ul>
1030
- </div>
1031
- </section>
1032
- </section>
1033
- <section id="footer">
1034
- <p class="copyright">&copy; YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
1035
- <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>
1036
- </section>
1037
- </article>
1038
- </div>
1039
- </body>
1040
- </div>
1041
- </html>