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
@@ -1,383 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <title>ParameterEncoding Enum Reference</title>
5
- <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7
- <meta charset='utf-8'>
8
- <script type="text/javascript">
9
- window.jazzy = {'docset': false}
10
- if (typeof window.dash != 'undefined') {
11
- document.documentElement.className += ' dash'
12
- window.jazzy.docset = true
13
- }
14
- if (navigator.userAgent.match(/xcode/i)) {
15
- document.documentElement.className += ' xcode'
16
- window.jazzy.docset = true
17
- }
18
- </script>
19
- <script src="../js/jquery.min.js" defer></script>
20
- <script src="../js/jazzy.js" defer></script>
21
- </head>
22
- <body id="reference" class="Swift">
23
- <a name="//apple_ref/swift/Enum/ParameterEncoding" class="dashAnchor"></a>
24
- <a title="ParameterEncoding Enum Reference"></a>
25
- <header>
26
- <div class="content-wrapper">
27
- <p class="header-text"><a href="../index.html">Alamofire Docs</a> (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
- ParameterEncoding Enum 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">ParameterEncoding</h1>
174
- <section>
175
- <section class="section">
176
- <p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</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:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">
190
- <a name="//apple_ref/swift/Method/encode(_:parameters:)" class="dashAnchor"></a>
191
- <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">encode(_:parameters:)</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">Creates a URL request by encoding parameters and applying them onto an existing request.</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">func</span> <span class="nf">encode</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
207
-
208
- </div>
209
- </div>
210
- <div class="parameters">
211
- <h4>Parameters</h4>
212
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
213
- <tbody>
214
- <tr>
215
- <td scope="row">
216
- <code>
217
- <em class="term">URLRequest</em>
218
- </code>
219
- </td>
220
- <td>
221
- <div class="definition">
222
- <p class="para">The request to have parameters applied</p>
223
- </div>
224
- </td>
225
- </tr>
226
- <tr>
227
- <td scope="row">
228
- <code>
229
- <em class="term">parameters</em>
230
- </code>
231
- </td>
232
- <td>
233
- <div class="definition">
234
- <p class="para">The parameters to apply</p>
235
- </div>
236
- </td>
237
- </tr>
238
- </tbody>
239
- </table>
240
- </div>
241
- <div class="result-description">
242
- <h4>Return Value</h4>
243
- <p class="para">A tuple containing the constructed request and the error that occurred during parameter encoding, if any.</p>
244
- </div>
245
- <div class="result-description view-on-github">
246
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L77">Show on GitHub</a>
247
- </div>
248
- </section>
249
- </div>
250
- </li>
251
- <li class="item symbol">
252
- <div class="task-group-term">
253
- <code>
254
- <a name="/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">
255
- <a name="//apple_ref/swift/Element/Custom" class="dashAnchor"></a>
256
- <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">Custom</a>
257
- </code>
258
- </div>
259
- <div class="height-container">
260
- <div class="pointy-thing-container"></div>
261
- <section class="section instance-method">
262
- <div class="pointy-thing"></div>
263
- <div class="abstract">
264
- <p class="para">Uses the associated closure value to construct a new request given an existing request and parameters.</p>
265
- </div>
266
- <div class="declaration">
267
- <h4>Declaration</h4>
268
-
269
- <div class="Swift">
270
- <p class="aside-title">Swift</p>
271
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Custom</span><span class="p">((</span><span class="kt">URLRequestConvertible</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">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?))</span></code></pre>
272
-
273
- </div>
274
- </div>
275
- <div class="result-description view-on-github">
276
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L67">Show on GitHub</a>
277
- </div>
278
- </section>
279
- </div>
280
- </li>
281
- <li class="item symbol">
282
- <div class="task-group-term">
283
- <code>
284
- <a name="/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">
285
- <a name="//apple_ref/swift/Element/URL" class="dashAnchor"></a>
286
- <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">URL</a>
287
- </code>
288
- </div>
289
- <div class="height-container">
290
- <div class="pointy-thing-container"></div>
291
- <section class="section instance-method">
292
- <div class="pointy-thing"></div>
293
- <div class="abstract">
294
- <p class="para">A query string to be set as or appended to any existing URL query for <code>GET</code>, <code>HEAD</code>, and <code>DELETE</code> requests, or set as the body for requests with any other HTTP method. The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to <code>application/x-www-form-urlencoded</code>. Since there is no published specification for how to encode collection types, the convention of appending <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for nested dictionary values (<code>foo[bar]=baz</code>).</p>
295
- </div>
296
- <div class="declaration">
297
- <h4>Declaration</h4>
298
-
299
- <div class="Swift">
300
- <p class="aside-title">Swift</p>
301
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">URL</span></code></pre>
302
-
303
- </div>
304
- </div>
305
- <div class="result-description view-on-github">
306
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L52">Show on GitHub</a>
307
- </div>
308
- </section>
309
- </div>
310
- </li>
311
- <li class="item symbol">
312
- <div class="task-group-term">
313
- <code>
314
- <a name="/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">
315
- <a name="//apple_ref/swift/Element/JSON" class="dashAnchor"></a>
316
- <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">JSON</a>
317
- </code>
318
- </div>
319
- <div class="height-container">
320
- <div class="pointy-thing-container"></div>
321
- <section class="section instance-method">
322
- <div class="pointy-thing"></div>
323
- <div class="abstract">
324
- <p class="para">Uses <code>NSJSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
325
- </div>
326
- <div class="declaration">
327
- <h4>Declaration</h4>
328
-
329
- <div class="Swift">
330
- <p class="aside-title">Swift</p>
331
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">JSON</span></code></pre>
332
-
333
- </div>
334
- </div>
335
- <div class="result-description view-on-github">
336
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L57">Show on GitHub</a>
337
- </div>
338
- </section>
339
- </div>
340
- </li>
341
- <li class="item symbol">
342
- <div class="task-group-term">
343
- <code>
344
- <a name="/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">
345
- <a name="//apple_ref/swift/Element/PropertyList" class="dashAnchor"></a>
346
- <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">PropertyList</a>
347
- </code>
348
- </div>
349
- <div class="height-container">
350
- <div class="pointy-thing-container"></div>
351
- <section class="section instance-method">
352
- <div class="pointy-thing"></div>
353
- <div class="abstract">
354
- <p class="para">Uses <code>NSPropertyListSerialization</code> to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/x-plist</code>.</p>
355
- </div>
356
- <div class="declaration">
357
- <h4>Declaration</h4>
358
-
359
- <div class="Swift">
360
- <p class="aside-title">Swift</p>
361
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">PropertyList</span><span class="p">(</span><span class="kt">NSPropertyListFormat</span><span class="p">,</span> <span class="kt">NSPropertyListWriteOptions</span><span class="p">)</span></code></pre>
362
-
363
- </div>
364
- </div>
365
- <div class="result-description view-on-github">
366
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L62">Show on GitHub</a>
367
- </div>
368
- </section>
369
- </div>
370
- </li>
371
- </ul>
372
- </div>
373
- </section>
374
- </section>
375
- <section id="footer">
376
- <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>
377
- <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>
378
- </section>
379
- </article>
380
- </div>
381
- </body>
382
- </div>
383
- </html>
@@ -1,276 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <title>Protocols 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="Protocols 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
- Protocols 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">Protocols</h1>
173
- <section>
174
- <section class="section">
175
- <p class="para">The following protocols 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="/URLStringConvertible"></a>
182
- <a name="//apple_ref/swift/Section/URLStringConvertible" class="dashAnchor"></a>
183
- <a href="#/URLStringConvertible">
184
- <h3 class="section-name">URLStringConvertible</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:P9Alamofire20URLStringConvertible">
193
- <a name="//apple_ref/swift/Protocol/URLStringConvertible" class="dashAnchor"></a>
194
- <a class="x-instance-method Swift" href="#/s:P9Alamofire20URLStringConvertible">URLStringConvertible</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">Types adopting the <code>URLStringConvertible</code> protocol can be used to construct URL strings, which are then used to construct URL requests.</p>
203
- <a href="Protocols/URLStringConvertible.html" class="see-more">See more</a>
204
- </div>
205
- <div class="declaration">
206
- <h4>Declaration</h4>
207
-
208
- <div class="Swift">
209
- <p class="aside-title">Swift</p>
210
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLStringConvertible</span></code></pre>
211
-
212
- </div>
213
- </div>
214
- <div class="result-description view-on-github">
215
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L165">Show on GitHub</a>
216
- </div>
217
- </section>
218
- </div>
219
- </li>
220
- </ul>
221
- </div>
222
- <div class="task-group">
223
- <div class="task-name-container">
224
- <hr/>
225
- <a name="/URLRequestConvertible"></a>
226
- <a name="//apple_ref/swift/Section/URLRequestConvertible" class="dashAnchor"></a>
227
- <a href="#/URLRequestConvertible">
228
- <h3 class="section-name">URLRequestConvertible</h3>
229
- </a>
230
-
231
- </div>
232
- <ul class="task-group-list">
233
- <li class="item symbol">
234
- <div class="task-group-term">
235
- <code>
236
- <a name="/s:P9Alamofire21URLRequestConvertible">
237
- <a name="//apple_ref/swift/Protocol/URLRequestConvertible" class="dashAnchor"></a>
238
- <a class="x-instance-method Swift" href="#/s:P9Alamofire21URLRequestConvertible">URLRequestConvertible</a>
239
- </code>
240
- </div>
241
- <div class="height-container">
242
- <div class="pointy-thing-container"></div>
243
- <section class="section instance-method">
244
- <div class="pointy-thing"></div>
245
- <div class="abstract">
246
- <p class="para">Types adopting the <code>URLRequestConvertible</code> protocol can be used to construct URL requests.</p>
247
- <a href="Protocols/URLRequestConvertible.html" class="see-more">See more</a>
248
- </div>
249
- <div class="declaration">
250
- <h4>Declaration</h4>
251
-
252
- <div class="Swift">
253
- <p class="aside-title">Swift</p>
254
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLRequestConvertible</span></code></pre>
255
-
256
- </div>
257
- </div>
258
- <div class="result-description view-on-github">
259
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L199">Show on GitHub</a>
260
- </div>
261
- </section>
262
- </div>
263
- </li>
264
- </ul>
265
- </div>
266
- </section>
267
- </section>
268
- <section id="footer">
269
- <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>
270
- <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>
271
- </section>
272
- </article>
273
- </div>
274
- </body>
275
- </div>
276
- </html>