AlamofireExtension.html 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>AlamofireExtension Structure 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 src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Struct/AlamofireExtension" class="dashAnchor"></a>
  16. <a title="AlamofireExtension Structure Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (98% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. AlamofireExtension Structure Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  254. </li>
  255. </ul>
  256. </li>
  257. <li class="nav-group-name">
  258. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  259. <ul class="nav-group-tasks">
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  322. </li>
  323. </ul>
  324. </li>
  325. <li class="nav-group-name">
  326. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  327. <ul class="nav-group-tasks">
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  381. </li>
  382. </ul>
  383. </li>
  384. <li class="nav-group-name">
  385. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  386. <ul class="nav-group-tasks">
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  404. </li>
  405. </ul>
  406. </li>
  407. </ul>
  408. </nav>
  409. <article class="main-content">
  410. <section class="section">
  411. <div class="section-content">
  412. <h1>AlamofireExtension</h1>
  413. <div class="declaration">
  414. <div class="language">
  415. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">AlamofireExtension</span><span class="o">&lt;</span><span class="kt">ExtendedType</span><span class="o">&gt;</span></code></pre>
  416. </div>
  417. </div>
  418. <p>Type that acts as a generic extension point for all <code><a href="../Protocols/AlamofireExtended.html">AlamofireExtended</a></code> types.</p>
  419. </div>
  420. </section>
  421. <section class="section">
  422. <div class="section-content">
  423. <div class="task-group">
  424. <div class="task-name-container">
  425. <a name="/Extensions"></a>
  426. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  427. <a href="#/Extensions">
  428. <h3 class="section-name">Extensions</h3>
  429. </a>
  430. </div>
  431. <ul class="item-container">
  432. <li class="item">
  433. <div>
  434. <code>
  435. <a name="/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE12certificatesSaySo17SecCertificateRefaGvp"></a>
  436. <a name="//apple_ref/swift/Property/certificates" class="dashAnchor"></a>
  437. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE12certificatesSaySo17SecCertificateRefaGvp">certificates</a>
  438. </code>
  439. </div>
  440. <div class="height-container">
  441. <div class="pointer-container"></div>
  442. <section class="section">
  443. <div class="pointer"></div>
  444. <div class="abstract">
  445. <p>Returns all valid <code>cer</code>, <code>crt</code>, and <code>der</code> certificates in the bundle.</p>
  446. </div>
  447. <div class="declaration">
  448. <h4>Declaration</h4>
  449. <div class="language">
  450. <p class="aside-title">Swift</p>
  451. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">certificates</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecCertificate</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  452. </div>
  453. </div>
  454. </section>
  455. </div>
  456. </li>
  457. <li class="item">
  458. <div>
  459. <code>
  460. <a name="/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE10publicKeysSaySo9SecKeyRefaGvp"></a>
  461. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  462. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE10publicKeysSaySo9SecKeyRefaGvp">publicKeys</a>
  463. </code>
  464. </div>
  465. <div class="height-container">
  466. <div class="pointer-container"></div>
  467. <section class="section">
  468. <div class="pointer"></div>
  469. <div class="abstract">
  470. <p>Returns all public keys for the valid certificates in the bundle.</p>
  471. </div>
  472. <div class="declaration">
  473. <h4>Declaration</h4>
  474. <div class="language">
  475. <p class="aside-title">Swift</p>
  476. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">publicKeys</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecKey</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  477. </div>
  478. </div>
  479. </section>
  480. </div>
  481. </li>
  482. <li class="item">
  483. <div>
  484. <code>
  485. <a name="/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE5paths19forResourcesOfTypesSaySSGAH_tF"></a>
  486. <a name="//apple_ref/swift/Method/paths(forResourcesOfTypes:)" class="dashAnchor"></a>
  487. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE5paths19forResourcesOfTypesSaySSGAH_tF">paths(forResourcesOfTypes:)</a>
  488. </code>
  489. </div>
  490. <div class="height-container">
  491. <div class="pointer-container"></div>
  492. <section class="section">
  493. <div class="pointer"></div>
  494. <div class="abstract">
  495. <p>Returns all pathnames for the resources identified by the provided file extensions.</p>
  496. </div>
  497. <div class="declaration">
  498. <h4>Declaration</h4>
  499. <div class="language">
  500. <p class="aside-title">Swift</p>
  501. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">paths</span><span class="p">(</span><span class="n">forResourcesOfTypes</span> <span class="nv">types</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</span></code></pre>
  502. </div>
  503. </div>
  504. <div>
  505. <h4>Parameters</h4>
  506. <table class="graybox">
  507. <tbody>
  508. <tr>
  509. <td>
  510. <code>
  511. <em>types</em>
  512. </code>
  513. </td>
  514. <td>
  515. <div>
  516. <p>The filename extensions locate.</p>
  517. </div>
  518. </td>
  519. </tr>
  520. </tbody>
  521. </table>
  522. </div>
  523. <div>
  524. <h4>Return Value</h4>
  525. <p>All pathnames for the given filename extensions.</p>
  526. </div>
  527. </section>
  528. </div>
  529. </li>
  530. </ul>
  531. </div>
  532. <div class="task-group">
  533. <div class="task-name-container">
  534. <a name="/Extensions2"></a>
  535. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  536. <a href="#/Extensions2">
  537. <h3 class="section-name">Extensions</h3>
  538. </a>
  539. </div>
  540. <ul class="item-container">
  541. <li class="item">
  542. <div>
  543. <code>
  544. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate6policy13errorProducerySo0c6PolicyE0a_s5Error_ps5Int32V_So0cD10ResultTypeVtXEtKF"></a>
  545. <a name="//apple_ref/swift/Method/validate(policy:errorProducer:)" class="dashAnchor"></a>
  546. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate6policy13errorProducerySo0c6PolicyE0a_s5Error_ps5Int32V_So0cD10ResultTypeVtXEtKF">validate(policy:errorProducer:)</a>
  547. </code>
  548. </div>
  549. <div class="height-container">
  550. <div class="pointer-container"></div>
  551. <section class="section">
  552. <div class="pointer"></div>
  553. <div class="abstract">
  554. <p>Attempts to validate <code>self</code> using the policy provided and transforming any error produced using the closure passed.</p>
  555. <div class="aside aside-throws">
  556. <p class="aside-title">Throws</p>
  557. Any error from applying the <code>policy</code>, or the result of <code>errorProducer</code> if validation fails.
  558. </div>
  559. </div>
  560. <div class="declaration">
  561. <h4>Declaration</h4>
  562. <div class="language">
  563. <p class="aside-title">Swift</p>
  564. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">policy</span><span class="p">:</span> <span class="kt">SecPolicy</span><span class="p">,</span> <span class="nv">errorProducer</span><span class="p">:</span> <span class="p">(</span><span class="n">_</span> <span class="nv">status</span><span class="p">:</span> <span class="kt">OSStatus</span><span class="p">,</span> <span class="n">_</span> <span class="nv">result</span><span class="p">:</span> <span class="kt">SecTrustResultType</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Error</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  565. </div>
  566. </div>
  567. <div>
  568. <h4>Parameters</h4>
  569. <table class="graybox">
  570. <tbody>
  571. <tr>
  572. <td>
  573. <code>
  574. <em>policy</em>
  575. </code>
  576. </td>
  577. <td>
  578. <div>
  579. <p>The <code>SecPolicy</code> used to evaluate <code>self</code>.</p>
  580. </div>
  581. </td>
  582. </tr>
  583. <tr>
  584. <td>
  585. <code>
  586. <em>errorProducer</em>
  587. </code>
  588. </td>
  589. <td>
  590. <div>
  591. <p>The closure used transform the failed <code>OSStatus</code> and <code>SecTrustResultType</code>.</p>
  592. </div>
  593. </td>
  594. </tr>
  595. </tbody>
  596. </table>
  597. </div>
  598. </section>
  599. </div>
  600. </li>
  601. <li class="item">
  602. <div>
  603. <code>
  604. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE5apply6policyAESo0c6PolicyE0a_tKF"></a>
  605. <a name="//apple_ref/swift/Method/apply(policy:)" class="dashAnchor"></a>
  606. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE5apply6policyAESo0c6PolicyE0a_tKF">apply(policy:)</a>
  607. </code>
  608. </div>
  609. <div class="height-container">
  610. <div class="pointer-container"></div>
  611. <section class="section">
  612. <div class="pointer"></div>
  613. <div class="abstract">
  614. <p>Applies a <code>SecPolicy</code> to <code>self</code>, throwing if it fails.</p>
  615. <div class="aside aside-throws">
  616. <p class="aside-title">Throws</p>
  617. <p>An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.policyApplicationFailed</code> reason.</p>
  618. </div>
  619. </div>
  620. <div class="declaration">
  621. <h4>Declaration</h4>
  622. <div class="language">
  623. <p class="aside-title">Swift</p>
  624. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="nv">policy</span><span class="p">:</span> <span class="kt">SecPolicy</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">SecTrust</span></code></pre>
  625. </div>
  626. </div>
  627. <div>
  628. <h4>Parameters</h4>
  629. <table class="graybox">
  630. <tbody>
  631. <tr>
  632. <td>
  633. <code>
  634. <em>policy</em>
  635. </code>
  636. </td>
  637. <td>
  638. <div>
  639. <p>The <code>SecPolicy</code>.</p>
  640. </div>
  641. </td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. </div>
  646. <div>
  647. <h4>Return Value</h4>
  648. <p><code>self</code>, with the policy applied.</p>
  649. </div>
  650. </section>
  651. </div>
  652. </li>
  653. <li class="item">
  654. <div>
  655. <code>
  656. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate13errorProducerys5Error_ps5Int32V_So0cD10ResultTypeVtXE_tKF"></a>
  657. <a name="//apple_ref/swift/Method/validate(errorProducer:)" class="dashAnchor"></a>
  658. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate13errorProducerys5Error_ps5Int32V_So0cD10ResultTypeVtXE_tKF">validate(errorProducer:)</a>
  659. </code>
  660. </div>
  661. <div class="height-container">
  662. <div class="pointer-container"></div>
  663. <section class="section">
  664. <div class="pointer"></div>
  665. <div class="abstract">
  666. <p>Validate <code>self</code>, passing any failure values through <code>errorProducer</code>.</p>
  667. <div class="aside aside-throws">
  668. <p class="aside-title">Throws</p>
  669. The <code>Error</code> produced by the <code>errorProducer</code> closure.
  670. </div>
  671. </div>
  672. <div class="declaration">
  673. <h4>Declaration</h4>
  674. <div class="language">
  675. <p class="aside-title">Swift</p>
  676. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">errorProducer</span><span class="p">:</span> <span class="p">(</span><span class="n">_</span> <span class="nv">status</span><span class="p">:</span> <span class="kt">OSStatus</span><span class="p">,</span> <span class="n">_</span> <span class="nv">result</span><span class="p">:</span> <span class="kt">SecTrustResultType</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Error</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  677. </div>
  678. </div>
  679. <div>
  680. <h4>Parameters</h4>
  681. <table class="graybox">
  682. <tbody>
  683. <tr>
  684. <td>
  685. <code>
  686. <em>errorProducer</em>
  687. </code>
  688. </td>
  689. <td>
  690. <div>
  691. <p>The closure used to transform the failed <code>OSStatus</code> and <code>SecTrustResultType</code> into an
  692. <code>Error</code>.</p>
  693. </div>
  694. </td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. <li class="item">
  703. <div>
  704. <code>
  705. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE21setAnchorCertificatesyySaySo0c11CertificateE0aGKF"></a>
  706. <a name="//apple_ref/swift/Method/setAnchorCertificates(_:)" class="dashAnchor"></a>
  707. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE21setAnchorCertificatesyySaySo0c11CertificateE0aGKF">setAnchorCertificates(_:)</a>
  708. </code>
  709. </div>
  710. <div class="height-container">
  711. <div class="pointer-container"></div>
  712. <section class="section">
  713. <div class="pointer"></div>
  714. <div class="abstract">
  715. <p>Sets a custom certificate chain on <code>self</code>, allowing full validation of a self-signed certificate and its chain.</p>
  716. <div class="aside aside-throws">
  717. <p class="aside-title">Throws</p>
  718. Any error produced when applying the new certificate chain.
  719. </div>
  720. </div>
  721. <div class="declaration">
  722. <h4>Declaration</h4>
  723. <div class="language">
  724. <p class="aside-title">Swift</p>
  725. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">setAnchorCertificates</span><span class="p">(</span><span class="n">_</span> <span class="nv">certificates</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecCertificate</span><span class="p">])</span> <span class="k">throws</span></code></pre>
  726. </div>
  727. </div>
  728. <div>
  729. <h4>Parameters</h4>
  730. <table class="graybox">
  731. <tbody>
  732. <tr>
  733. <td>
  734. <code>
  735. <em>certificates</em>
  736. </code>
  737. </td>
  738. <td>
  739. <div>
  740. <p>The <code>SecCertificate</code>s to add to the chain.</p>
  741. </div>
  742. </td>
  743. </tr>
  744. </tbody>
  745. </table>
  746. </div>
  747. </section>
  748. </div>
  749. </li>
  750. <li class="item">
  751. <div>
  752. <code>
  753. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE10publicKeysSaySo0c3KeyE0aGvp"></a>
  754. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  755. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE10publicKeysSaySo0c3KeyE0aGvp">publicKeys</a>
  756. </code>
  757. </div>
  758. <div class="height-container">
  759. <div class="pointer-container"></div>
  760. <section class="section">
  761. <div class="pointer"></div>
  762. <div class="abstract">
  763. <p>The public keys contained in <code>self</code>.</p>
  764. </div>
  765. <div class="declaration">
  766. <h4>Declaration</h4>
  767. <div class="language">
  768. <p class="aside-title">Swift</p>
  769. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">publicKeys</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecKey</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  770. </div>
  771. </div>
  772. </section>
  773. </div>
  774. </li>
  775. <li class="item">
  776. <div>
  777. <code>
  778. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE12certificatesSaySo0c11CertificateE0aGvp"></a>
  779. <a name="//apple_ref/swift/Property/certificates" class="dashAnchor"></a>
  780. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE12certificatesSaySo0c11CertificateE0aGvp">certificates</a>
  781. </code>
  782. </div>
  783. <div class="height-container">
  784. <div class="pointer-container"></div>
  785. <section class="section">
  786. <div class="pointer"></div>
  787. <div class="abstract">
  788. <p>The <code>SecCertificate</code>s contained i <code>self</code>.</p>
  789. </div>
  790. <div class="declaration">
  791. <h4>Declaration</h4>
  792. <div class="language">
  793. <p class="aside-title">Swift</p>
  794. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">certificates</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecCertificate</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  795. </div>
  796. </div>
  797. </section>
  798. </div>
  799. </li>
  800. <li class="item">
  801. <div>
  802. <code>
  803. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE15certificateDataSay10Foundation0G0VGvp"></a>
  804. <a name="//apple_ref/swift/Property/certificateData" class="dashAnchor"></a>
  805. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE15certificateDataSay10Foundation0G0VGvp">certificateData</a>
  806. </code>
  807. </div>
  808. <div class="height-container">
  809. <div class="pointer-container"></div>
  810. <section class="section">
  811. <div class="pointer"></div>
  812. <div class="abstract">
  813. <p>The <code>Data</code> values for all certificates contained in <code>self</code>.</p>
  814. </div>
  815. <div class="declaration">
  816. <h4>Declaration</h4>
  817. <div class="language">
  818. <p class="aside-title">Swift</p>
  819. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">certificateData</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  820. </div>
  821. </div>
  822. </section>
  823. </div>
  824. </li>
  825. <li class="item">
  826. <div>
  827. <code>
  828. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE24performDefaultValidation7forHostySS_tKF"></a>
  829. <a name="//apple_ref/swift/Method/performDefaultValidation(forHost:)" class="dashAnchor"></a>
  830. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE24performDefaultValidation7forHostySS_tKF">performDefaultValidation(forHost:)</a>
  831. </code>
  832. </div>
  833. <div class="height-container">
  834. <div class="pointer-container"></div>
  835. <section class="section">
  836. <div class="pointer"></div>
  837. <div class="abstract">
  838. <p>Validates <code>self</code> after applying <code>SecPolicy.af.default</code>. This evaluation does not validate the hostname.</p>
  839. <div class="aside aside-throws">
  840. <p class="aside-title">Throws</p>
  841. An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.defaultEvaluationFailed</code> reason.
  842. </div>
  843. </div>
  844. <div class="declaration">
  845. <h4>Declaration</h4>
  846. <div class="language">
  847. <p class="aside-title">Swift</p>
  848. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">performDefaultValidation</span><span class="p">(</span><span class="n">forHost</span> <span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  849. </div>
  850. </div>
  851. <div>
  852. <h4>Parameters</h4>
  853. <table class="graybox">
  854. <tbody>
  855. <tr>
  856. <td>
  857. <code>
  858. <em>host</em>
  859. </code>
  860. </td>
  861. <td>
  862. <div>
  863. <p>The hostname, used only in the error output if validation fails.</p>
  864. </div>
  865. </td>
  866. </tr>
  867. </tbody>
  868. </table>
  869. </div>
  870. </section>
  871. </div>
  872. </li>
  873. <li class="item">
  874. <div>
  875. <code>
  876. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE17performValidation7forHostySS_tKF"></a>
  877. <a name="//apple_ref/swift/Method/performValidation(forHost:)" class="dashAnchor"></a>
  878. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE17performValidation7forHostySS_tKF">performValidation(forHost:)</a>
  879. </code>
  880. </div>
  881. <div class="height-container">
  882. <div class="pointer-container"></div>
  883. <section class="section">
  884. <div class="pointer"></div>
  885. <div class="abstract">
  886. <p>Validates <code>self</code> after applying <code>SecPolicy.af.hostname(host)</code>, which performs the default validation as well as
  887. hostname validation.</p>
  888. <div class="aside aside-throws">
  889. <p class="aside-title">Throws</p>
  890. An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.defaultEvaluationFailed</code> reason.
  891. </div>
  892. </div>
  893. <div class="declaration">
  894. <h4>Declaration</h4>
  895. <div class="language">
  896. <p class="aside-title">Swift</p>
  897. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">performValidation</span><span class="p">(</span><span class="n">forHost</span> <span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  898. </div>
  899. </div>
  900. <div>
  901. <h4>Parameters</h4>
  902. <table class="graybox">
  903. <tbody>
  904. <tr>
  905. <td>
  906. <code>
  907. <em>host</em>
  908. </code>
  909. </td>
  910. <td>
  911. <div>
  912. <p>The hostname to use in the validation.</p>
  913. </div>
  914. </td>
  915. </tr>
  916. </tbody>
  917. </table>
  918. </div>
  919. </section>
  920. </div>
  921. </li>
  922. </ul>
  923. </div>
  924. <div class="task-group">
  925. <div class="task-name-container">
  926. <a name="/Extensions3"></a>
  927. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  928. <a href="#/Extensions3">
  929. <h3 class="section-name">Extensions</h3>
  930. </a>
  931. </div>
  932. <ul class="item-container">
  933. <li class="item">
  934. <div>
  935. <code>
  936. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE7defaultAEvpZ"></a>
  937. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  938. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE7defaultAEvpZ">default</a>
  939. </code>
  940. </div>
  941. <div class="height-container">
  942. <div class="pointer-container"></div>
  943. <section class="section">
  944. <div class="pointer"></div>
  945. <div class="abstract">
  946. <p>Creates a <code>SecPolicy</code> instance which will validate server certificates but not require a host name match.</p>
  947. </div>
  948. <div class="declaration">
  949. <h4>Declaration</h4>
  950. <div class="language">
  951. <p class="aside-title">Swift</p>
  952. <pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">let</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">SecPolicy</span></code></pre>
  953. </div>
  954. </div>
  955. </section>
  956. </div>
  957. </li>
  958. <li class="item">
  959. <div>
  960. <code>
  961. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE8hostnameyAESSFZ"></a>
  962. <a name="//apple_ref/swift/Method/hostname(_:)" class="dashAnchor"></a>
  963. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE8hostnameyAESSFZ">hostname(_:)</a>
  964. </code>
  965. </div>
  966. <div class="height-container">
  967. <div class="pointer-container"></div>
  968. <section class="section">
  969. <div class="pointer"></div>
  970. <div class="abstract">
  971. <p>Creates a <code>SecPolicy</code> instance which will validate server certificates and much match the provided hostname.</p>
  972. </div>
  973. <div class="declaration">
  974. <h4>Declaration</h4>
  975. <div class="language">
  976. <p class="aside-title">Swift</p>
  977. <pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">hostname</span><span class="p">(</span><span class="n">_</span> <span class="nv">hostname</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">SecPolicy</span></code></pre>
  978. </div>
  979. </div>
  980. <div>
  981. <h4>Parameters</h4>
  982. <table class="graybox">
  983. <tbody>
  984. <tr>
  985. <td>
  986. <code>
  987. <em>hostname</em>
  988. </code>
  989. </td>
  990. <td>
  991. <div>
  992. <p>The hostname to validate against.</p>
  993. </div>
  994. </td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. </div>
  999. <div>
  1000. <h4>Return Value</h4>
  1001. <p>The <code>SecPolicy</code>.</p>
  1002. </div>
  1003. </section>
  1004. </div>
  1005. </li>
  1006. <li class="item">
  1007. <div>
  1008. <code>
  1009. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE10revocation7optionsAeA24RevocationTrustEvaluatorC7OptionsV_tKFZ"></a>
  1010. <a name="//apple_ref/swift/Method/revocation(options:)" class="dashAnchor"></a>
  1011. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE10revocation7optionsAeA24RevocationTrustEvaluatorC7OptionsV_tKFZ">revocation(options:)</a>
  1012. </code>
  1013. </div>
  1014. <div class="height-container">
  1015. <div class="pointer-container"></div>
  1016. <section class="section">
  1017. <div class="pointer"></div>
  1018. <div class="abstract">
  1019. <p>Creates a <code>SecPolicy</code> which checks the revocation of certificates.</p>
  1020. <div class="aside aside-throws">
  1021. <p class="aside-title">Throws</p>
  1022. <p>An <code>AFError.serverTrustEvaluationFailed</code> error with reason <code>.revocationPolicyCreationFailed</code>
  1023. if the policy cannot be created.</p>
  1024. </div>
  1025. </div>
  1026. <div class="declaration">
  1027. <h4>Declaration</h4>
  1028. <div class="language">
  1029. <p class="aside-title">Swift</p>
  1030. <pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">revocation</span><span class="p">(</span><span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a></span><span class="o">.</span><span class="kt">Options</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">SecPolicy</span></code></pre>
  1031. </div>
  1032. </div>
  1033. <div>
  1034. <h4>Parameters</h4>
  1035. <table class="graybox">
  1036. <tbody>
  1037. <tr>
  1038. <td>
  1039. <code>
  1040. <em>options</em>
  1041. </code>
  1042. </td>
  1043. <td>
  1044. <div>
  1045. <p>The <code><a href="../Classes/RevocationTrustEvaluator/Options.html">RevocationTrustEvaluator.Options</a></code> for evaluation.</p>
  1046. </div>
  1047. </td>
  1048. </tr>
  1049. </tbody>
  1050. </table>
  1051. </div>
  1052. <div>
  1053. <h4>Return Value</h4>
  1054. <p>The <code>SecPolicy</code>.</p>
  1055. </div>
  1056. </section>
  1057. </div>
  1058. </li>
  1059. </ul>
  1060. </div>
  1061. <div class="task-group">
  1062. <div class="task-name-container">
  1063. <a name="/Extensions4"></a>
  1064. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  1065. <a href="#/Extensions4">
  1066. <h3 class="section-name">Extensions</h3>
  1067. </a>
  1068. </div>
  1069. <ul class="item-container">
  1070. <li class="item">
  1071. <div>
  1072. <code>
  1073. <a name="/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE4dataSay10Foundation4DataVGvp"></a>
  1074. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  1075. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE4dataSay10Foundation4DataVGvp">data</a>
  1076. </code>
  1077. </div>
  1078. <div class="height-container">
  1079. <div class="pointer-container"></div>
  1080. <section class="section">
  1081. <div class="pointer"></div>
  1082. <div class="abstract">
  1083. <p>All <code>Data</code> values for the contained <code>SecCertificate</code>s.</p>
  1084. </div>
  1085. <div class="declaration">
  1086. <h4>Declaration</h4>
  1087. <div class="language">
  1088. <p class="aside-title">Swift</p>
  1089. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1090. </div>
  1091. </div>
  1092. </section>
  1093. </div>
  1094. </li>
  1095. <li class="item">
  1096. <div>
  1097. <code>
  1098. <a name="/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE10publicKeysSaySo0c3KeyE0aGvp"></a>
  1099. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  1100. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE10publicKeysSaySo0c3KeyE0aGvp">publicKeys</a>
  1101. </code>
  1102. </div>
  1103. <div class="height-container">
  1104. <div class="pointer-container"></div>
  1105. <section class="section">
  1106. <div class="pointer"></div>
  1107. <div class="abstract">
  1108. <p>All public <code>SecKey</code> values for the contained <code>SecCertificate</code>s.</p>
  1109. </div>
  1110. <div class="declaration">
  1111. <h4>Declaration</h4>
  1112. <div class="language">
  1113. <p class="aside-title">Swift</p>
  1114. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">publicKeys</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecKey</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1115. </div>
  1116. </div>
  1117. </section>
  1118. </div>
  1119. </li>
  1120. </ul>
  1121. </div>
  1122. <div class="task-group">
  1123. <div class="task-name-container">
  1124. <a name="/Extensions5"></a>
  1125. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  1126. <a href="#/Extensions5">
  1127. <h3 class="section-name">Extensions</h3>
  1128. </a>
  1129. </div>
  1130. <ul class="item-container">
  1131. <li class="item">
  1132. <div>
  1133. <code>
  1134. <a name="/s:9Alamofire0A9ExtensionVAASo17SecCertificateRefaRszlE9publicKeySo0cgE0aSgvp"></a>
  1135. <a name="//apple_ref/swift/Property/publicKey" class="dashAnchor"></a>
  1136. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo17SecCertificateRefaRszlE9publicKeySo0cgE0aSgvp">publicKey</a>
  1137. </code>
  1138. </div>
  1139. <div class="height-container">
  1140. <div class="pointer-container"></div>
  1141. <section class="section">
  1142. <div class="pointer"></div>
  1143. <div class="abstract">
  1144. <p>The public key for <code>self</code>, if it can be extracted.</p>
  1145. </div>
  1146. <div class="declaration">
  1147. <h4>Declaration</h4>
  1148. <div class="language">
  1149. <p class="aside-title">Swift</p>
  1150. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">publicKey</span><span class="p">:</span> <span class="kt">SecKey</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1151. </div>
  1152. </div>
  1153. </section>
  1154. </div>
  1155. </li>
  1156. </ul>
  1157. </div>
  1158. <div class="task-group">
  1159. <div class="task-name-container">
  1160. <a name="/Extensions6"></a>
  1161. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  1162. <a href="#/Extensions6">
  1163. <h3 class="section-name">Extensions</h3>
  1164. </a>
  1165. </div>
  1166. <ul class="item-container">
  1167. <li class="item">
  1168. <div>
  1169. <code>
  1170. <a name="/s:9Alamofire0A9ExtensionVAAs5Int32VRszlE9isSuccessSbvp"></a>
  1171. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  1172. <a class="token" href="#/s:9Alamofire0A9ExtensionVAAs5Int32VRszlE9isSuccessSbvp">isSuccess</a>
  1173. </code>
  1174. </div>
  1175. <div class="height-container">
  1176. <div class="pointer-container"></div>
  1177. <section class="section">
  1178. <div class="pointer"></div>
  1179. <div class="abstract">
  1180. <p>Returns whether <code>self</code> is <code>errSecSuccess</code>.</p>
  1181. </div>
  1182. <div class="declaration">
  1183. <h4>Declaration</h4>
  1184. <div class="language">
  1185. <p class="aside-title">Swift</p>
  1186. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isSuccess</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1187. </div>
  1188. </div>
  1189. </section>
  1190. </div>
  1191. </li>
  1192. </ul>
  1193. </div>
  1194. <div class="task-group">
  1195. <div class="task-name-container">
  1196. <a name="/Extensions7"></a>
  1197. <a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
  1198. <a href="#/Extensions7">
  1199. <h3 class="section-name">Extensions</h3>
  1200. </a>
  1201. </div>
  1202. <ul class="item-container">
  1203. <li class="item">
  1204. <div>
  1205. <code>
  1206. <a name="/s:9Alamofire0A9ExtensionVAASo18SecTrustResultTypeVRszlE9isSuccessSbvp"></a>
  1207. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  1208. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo18SecTrustResultTypeVRszlE9isSuccessSbvp">isSuccess</a>
  1209. </code>
  1210. </div>
  1211. <div class="height-container">
  1212. <div class="pointer-container"></div>
  1213. <section class="section">
  1214. <div class="pointer"></div>
  1215. <div class="abstract">
  1216. <p>Returns whether <code>self is</code>.unspecified<code>or</code>.proceed`.</p>
  1217. </div>
  1218. <div class="declaration">
  1219. <h4>Declaration</h4>
  1220. <div class="language">
  1221. <p class="aside-title">Swift</p>
  1222. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isSuccess</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1223. </div>
  1224. </div>
  1225. </section>
  1226. </div>
  1227. </li>
  1228. </ul>
  1229. </div>
  1230. <div class="task-group">
  1231. <ul class="item-container">
  1232. <li class="item">
  1233. <div>
  1234. <code>
  1235. <a name="/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE7defaultAEvpZ"></a>
  1236. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  1237. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE7defaultAEvpZ">default</a>
  1238. </code>
  1239. </div>
  1240. <div class="height-container">
  1241. <div class="pointer-container"></div>
  1242. <section class="section">
  1243. <div class="pointer"></div>
  1244. <div class="abstract">
  1245. <p>Alamofire&rsquo;s default configuration. Same as <code>URLSessionConfiguration.default</code> but adds Alamofire default
  1246. <code>Accept-Language</code>, <code>Accept-Encoding</code>, and <code>User-Agent</code> headers.</p>
  1247. </div>
  1248. <div class="declaration">
  1249. <h4>Declaration</h4>
  1250. <div class="language">
  1251. <p class="aside-title">Swift</p>
  1252. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">var</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">URLSessionConfiguration</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1253. </div>
  1254. </div>
  1255. </section>
  1256. </div>
  1257. </li>
  1258. </ul>
  1259. </div>
  1260. </div>
  1261. </section>
  1262. </article>
  1263. </div>
  1264. <section class="footer">
  1265. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-09-08)</p>
  1266. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1267. </section>
  1268. </body>
  1269. </div>
  1270. </html>