AlamofireExtension.html 68 KB

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