AlamofireExtension.html 91 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703
  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 5.9.1 Docs
  21. </a>
  22. (96% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  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" alt=""/>
  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/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  263. </li>
  264. </ul>
  265. </li>
  266. <li class="nav-group-name">
  267. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  268. <ul class="nav-group-tasks">
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  322. </li>
  323. <li class="nav-group-task">
  324. <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  325. </li>
  326. </ul>
  327. </li>
  328. <li class="nav-group-name">
  329. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  330. <ul class="nav-group-tasks">
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  396. </li>
  397. <li class="nav-group-task">
  398. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  399. </li>
  400. <li class="nav-group-task">
  401. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  402. </li>
  403. <li class="nav-group-task">
  404. <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  405. </li>
  406. </ul>
  407. </li>
  408. <li class="nav-group-name">
  409. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  410. <ul class="nav-group-tasks">
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  506. </li>
  507. <li class="nav-group-task">
  508. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  509. </li>
  510. <li class="nav-group-task">
  511. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  512. </li>
  513. <li class="nav-group-task">
  514. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  515. </li>
  516. <li class="nav-group-task">
  517. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  518. </li>
  519. <li class="nav-group-task">
  520. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  521. </li>
  522. </ul>
  523. </li>
  524. <li class="nav-group-name">
  525. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  526. <ul class="nav-group-tasks">
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  529. </li>
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  532. </li>
  533. <li class="nav-group-task">
  534. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  535. </li>
  536. <li class="nav-group-task">
  537. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  538. </li>
  539. <li class="nav-group-task">
  540. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  541. </li>
  542. <li class="nav-group-task">
  543. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  544. </li>
  545. <li class="nav-group-task">
  546. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  547. </li>
  548. </ul>
  549. </li>
  550. </ul>
  551. </nav>
  552. <article class="main-content">
  553. <section class="section">
  554. <div class="section-content top-matter">
  555. <h1>AlamofireExtension</h1>
  556. <div class="declaration">
  557. <div class="language">
  558. <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>
  559. </div>
  560. </div>
  561. <p>Type that acts as a generic extension point for all <code><a href="../Protocols/AlamofireExtended.html">AlamofireExtended</a></code> types.</p>
  562. </div>
  563. </section>
  564. <section class="section">
  565. <div class="section-content">
  566. <div class="task-group">
  567. <ul class="item-container">
  568. <li class="item">
  569. <div>
  570. <code>
  571. <a name="/s:9Alamofire0A9ExtensionV4typexvp"></a>
  572. <a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
  573. <a class="token" href="#/s:9Alamofire0A9ExtensionV4typexvp">type</a>
  574. </code>
  575. </div>
  576. <div class="height-container">
  577. <div class="pointer-container"></div>
  578. <section class="section">
  579. <div class="pointer"></div>
  580. <div class="abstract">
  581. <p>Stores the type or meta-type of any extended type.</p>
  582. </div>
  583. <div class="declaration">
  584. <h4>Declaration</h4>
  585. <div class="language">
  586. <p class="aside-title">Swift</p>
  587. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">ExtendedType</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  588. </div>
  589. </div>
  590. </section>
  591. </div>
  592. </li>
  593. <li class="item">
  594. <div>
  595. <code>
  596. <a name="/s:9Alamofire0A9ExtensionVyACyxGxcfc"></a>
  597. <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
  598. <a class="token" href="#/s:9Alamofire0A9ExtensionVyACyxGxcfc">init(_:<wbr>)</a>
  599. </code>
  600. </div>
  601. <div class="height-container">
  602. <div class="pointer-container"></div>
  603. <section class="section">
  604. <div class="pointer"></div>
  605. <div class="abstract">
  606. <p>Create an instance from the provided value.</p>
  607. </div>
  608. <div class="declaration">
  609. <h4>Declaration</h4>
  610. <div class="language">
  611. <p class="aside-title">Swift</p>
  612. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">ExtendedType</span><span class="p">)</span></code></pre>
  613. </div>
  614. </div>
  615. <div>
  616. <h4>Parameters</h4>
  617. <table class="graybox">
  618. <tbody>
  619. <tr>
  620. <td>
  621. <code>
  622. <em>type</em>
  623. </code>
  624. </td>
  625. <td>
  626. <div>
  627. <p>Instance being extended.</p>
  628. </div>
  629. </td>
  630. </tr>
  631. </tbody>
  632. </table>
  633. </div>
  634. </section>
  635. </div>
  636. </li>
  637. </ul>
  638. </div>
  639. <div class="task-group">
  640. <div class="task-name-container">
  641. <a name="/Available%20where%20%60ExtendedType%60%3A%20%60URLSessionConfiguration%60"></a>
  642. <a name="//apple_ref/swift/Section/Available where `ExtendedType`: `URLSessionConfiguration`" class="dashAnchor"></a>
  643. <div class="section-name-container">
  644. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%3A%20%60URLSessionConfiguration%60"></a>
  645. <h3 class="section-name"><span>Available where <code>ExtendedType</code>: <code>URLSessionConfiguration</code></span>
  646. </h3>
  647. </div>
  648. </div>
  649. <ul class="item-container">
  650. <li class="item">
  651. <div>
  652. <code>
  653. <a name="/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE7defaultAEvpZ"></a>
  654. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  655. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE7defaultAEvpZ">default</a>
  656. </code>
  657. </div>
  658. <div class="height-container">
  659. <div class="pointer-container"></div>
  660. <section class="section">
  661. <div class="pointer"></div>
  662. <div class="abstract">
  663. <p>Alamofire&rsquo;s default configuration. Same as <code>URLSessionConfiguration.default</code> but adds Alamofire default
  664. <code>Accept-Language</code>, <code>Accept-Encoding</code>, and <code>User-Agent</code> headers.</p>
  665. </div>
  666. <div class="declaration">
  667. <h4>Declaration</h4>
  668. <div class="language">
  669. <p class="aside-title">Swift</p>
  670. <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>
  671. </div>
  672. </div>
  673. </section>
  674. </div>
  675. </li>
  676. <li class="item">
  677. <div>
  678. <code>
  679. <a name="/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE9ephemeralAEvpZ"></a>
  680. <a name="//apple_ref/swift/Variable/ephemeral" class="dashAnchor"></a>
  681. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo25NSURLSessionConfigurationCRbzlE9ephemeralAEvpZ">ephemeral</a>
  682. </code>
  683. </div>
  684. <div class="height-container">
  685. <div class="pointer-container"></div>
  686. <section class="section">
  687. <div class="pointer"></div>
  688. <div class="abstract">
  689. <p><code>.ephemeral</code> configuration with Alamofire&rsquo;s default <code>Accept-Language</code>, <code>Accept-Encoding</code>, and <code>User-Agent</code>
  690. headers.</p>
  691. </div>
  692. <div class="declaration">
  693. <h4>Declaration</h4>
  694. <div class="language">
  695. <p class="aside-title">Swift</p>
  696. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">ephemeral</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>
  697. </div>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. </ul>
  703. </div>
  704. <div class="task-group">
  705. <div class="task-name-container">
  706. <a name="/Available%20where%20%60ExtendedType%60%3A%20%60Bundle%60"></a>
  707. <a name="//apple_ref/swift/Section/Available where `ExtendedType`: `Bundle`" class="dashAnchor"></a>
  708. <div class="section-name-container">
  709. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%3A%20%60Bundle%60"></a>
  710. <h3 class="section-name"><span>Available where <code>ExtendedType</code>: <code>Bundle</code></span>
  711. </h3>
  712. </div>
  713. </div>
  714. <ul class="item-container">
  715. <li class="item">
  716. <div>
  717. <code>
  718. <a name="/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE12certificatesSaySo17SecCertificateRefaGvp"></a>
  719. <a name="//apple_ref/swift/Property/certificates" class="dashAnchor"></a>
  720. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE12certificatesSaySo17SecCertificateRefaGvp">certificates</a>
  721. </code>
  722. </div>
  723. <div class="height-container">
  724. <div class="pointer-container"></div>
  725. <section class="section">
  726. <div class="pointer"></div>
  727. <div class="abstract">
  728. <p>Returns all valid <code>cer</code>, <code>crt</code>, and <code>der</code> certificates in the bundle.</p>
  729. </div>
  730. <div class="declaration">
  731. <h4>Declaration</h4>
  732. <div class="language">
  733. <p class="aside-title">Swift</p>
  734. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  735. </div>
  736. </div>
  737. </section>
  738. </div>
  739. </li>
  740. <li class="item">
  741. <div>
  742. <code>
  743. <a name="/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE10publicKeysSaySo9SecKeyRefaGvp"></a>
  744. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  745. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE10publicKeysSaySo9SecKeyRefaGvp">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>Returns all public keys for the valid certificates in the bundle.</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="kd">public</span> <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:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE5paths19forResourcesOfTypesSaySSGAH_tF"></a>
  769. <a name="//apple_ref/swift/Method/paths(forResourcesOfTypes:)" class="dashAnchor"></a>
  770. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo8NSBundleCRbzlE5paths19forResourcesOfTypesSaySSGAH_tF">paths(forResourcesOfTypes:<wbr>)</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>Returns all pathnames for the resources identified by the provided file extensions.</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="kd">public</span> <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>
  785. </div>
  786. </div>
  787. <div>
  788. <h4>Parameters</h4>
  789. <table class="graybox">
  790. <tbody>
  791. <tr>
  792. <td>
  793. <code>
  794. <em>types</em>
  795. </code>
  796. </td>
  797. <td>
  798. <div>
  799. <p>The filename extensions locate.</p>
  800. </div>
  801. </td>
  802. </tr>
  803. </tbody>
  804. </table>
  805. </div>
  806. <div>
  807. <h4>Return Value</h4>
  808. <p>All pathnames for the given filename extensions.</p>
  809. </div>
  810. </section>
  811. </div>
  812. </li>
  813. </ul>
  814. </div>
  815. <div class="task-group">
  816. <div class="task-name-container">
  817. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecTrust%60"></a>
  818. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == `SecTrust`" class="dashAnchor"></a>
  819. <div class="section-name-container">
  820. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecTrust%60"></a>
  821. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == <code>SecTrust</code></span>
  822. </h3>
  823. </div>
  824. </div>
  825. <ul class="item-container">
  826. <li class="item">
  827. <div>
  828. <code>
  829. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8evaluate13afterApplyingySo0c6PolicyE0a_tKF"></a>
  830. <a name="//apple_ref/swift/Method/evaluate(afterApplying:)" class="dashAnchor"></a>
  831. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8evaluate13afterApplyingySo0c6PolicyE0a_tKF">evaluate(afterApplying:<wbr>)</a>
  832. </code>
  833. </div>
  834. <div class="height-container">
  835. <div class="pointer-container"></div>
  836. <section class="section">
  837. <div class="pointer"></div>
  838. <div class="abstract">
  839. <p>Evaluates <code>self</code> after applying the <code>SecPolicy</code> value provided.</p>
  840. <div class="aside aside-throws">
  841. <p class="aside-title">Throws</p>
  842. <p>Any <code>Error</code> from applying the <code>SecPolicy</code> or from evaluation.</p>
  843. </div>
  844. </div>
  845. <div class="declaration">
  846. <h4>Declaration</h4>
  847. <div class="language">
  848. <p class="aside-title">Swift</p>
  849. <pre class="highlight swift"><code><span class="kd">@available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *)</span>
  850. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">evaluate</span><span class="p">(</span><span class="n">afterApplying</span> <span class="nv">policy</span><span class="p">:</span> <span class="kt">SecPolicy</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  851. </div>
  852. </div>
  853. <div>
  854. <h4>Parameters</h4>
  855. <table class="graybox">
  856. <tbody>
  857. <tr>
  858. <td>
  859. <code>
  860. <em>policy</em>
  861. </code>
  862. </td>
  863. <td>
  864. <div>
  865. <p>The <code>SecPolicy</code> to apply to <code>self</code> before evaluation.</p>
  866. </div>
  867. </td>
  868. </tr>
  869. </tbody>
  870. </table>
  871. </div>
  872. </section>
  873. </div>
  874. </li>
  875. <li class="item">
  876. <div>
  877. <code>
  878. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate6policy13errorProducerySo0c6PolicyE0a_s5Error_ps5Int32V_So0cD10ResultTypeVtXEtKF"></a>
  879. <a name="//apple_ref/swift/Method/validate(policy:errorProducer:)" class="dashAnchor"></a>
  880. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate6policy13errorProducerySo0c6PolicyE0a_s5Error_ps5Int32V_So0cD10ResultTypeVtXEtKF">validate(policy:<wbr>errorProducer:<wbr>)</a>
  881. </code>
  882. </div>
  883. <div class="height-container">
  884. <div class="pointer-container"></div>
  885. <section class="section">
  886. <div class="pointer"></div>
  887. <div class="abstract">
  888. <p>Attempts to validate <code>self</code> using the <code>SecPolicy</code> provided and transforming any error produced using the closure passed.</p>
  889. <div class="aside aside-throws">
  890. <p class="aside-title">Throws</p>
  891. Any <code>Error</code> from applying the <code>policy</code>, or the result of <code>errorProducer</code> if validation fails.
  892. </div>
  893. </div>
  894. <div class="declaration">
  895. <h4>Declaration</h4>
  896. <div class="language">
  897. <p class="aside-title">Swift</p>
  898. <pre class="highlight swift"><code><span class="kd">@available(iOS, introduced: 10, deprecated: 12, renamed: "evaluate(afterApplying:﹚")</span>
  899. <span class="kd">@available(macOS, introduced: 10.12, deprecated: 10.14, renamed: "evaluate(afterApplying:﹚")</span>
  900. <span class="kd">@available(tvOS, introduced: 10, deprecated: 12, renamed: "evaluate(afterApplying:﹚")</span>
  901. <span class="kd">@available(watchOS, introduced: 3, deprecated: 5, renamed: "evaluate(afterApplying:﹚")</span>
  902. <span class="kd">public</span> <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>
  903. </div>
  904. </div>
  905. <div>
  906. <h4>Parameters</h4>
  907. <table class="graybox">
  908. <tbody>
  909. <tr>
  910. <td>
  911. <code>
  912. <em>policy</em>
  913. </code>
  914. </td>
  915. <td>
  916. <div>
  917. <p>The <code>SecPolicy</code> used to evaluate <code>self</code>.</p>
  918. </div>
  919. </td>
  920. </tr>
  921. <tr>
  922. <td>
  923. <code>
  924. <em>errorProducer</em>
  925. </code>
  926. </td>
  927. <td>
  928. <div>
  929. <p>The closure used transform the failed <code>OSStatus</code> and <code>SecTrustResultType</code>.</p>
  930. </div>
  931. </td>
  932. </tr>
  933. </tbody>
  934. </table>
  935. </div>
  936. </section>
  937. </div>
  938. </li>
  939. <li class="item">
  940. <div>
  941. <code>
  942. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE5apply6policyAESo0c6PolicyE0a_tKF"></a>
  943. <a name="//apple_ref/swift/Method/apply(policy:)" class="dashAnchor"></a>
  944. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE5apply6policyAESo0c6PolicyE0a_tKF">apply(policy:<wbr>)</a>
  945. </code>
  946. </div>
  947. <div class="height-container">
  948. <div class="pointer-container"></div>
  949. <section class="section">
  950. <div class="pointer"></div>
  951. <div class="abstract">
  952. <p>Applies a <code>SecPolicy</code> to <code>self</code>, throwing if it fails.</p>
  953. <div class="aside aside-throws">
  954. <p class="aside-title">Throws</p>
  955. <p>An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.policyApplicationFailed</code> reason.</p>
  956. </div>
  957. </div>
  958. <div class="declaration">
  959. <h4>Declaration</h4>
  960. <div class="language">
  961. <p class="aside-title">Swift</p>
  962. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  963. </div>
  964. </div>
  965. <div>
  966. <h4>Parameters</h4>
  967. <table class="graybox">
  968. <tbody>
  969. <tr>
  970. <td>
  971. <code>
  972. <em>policy</em>
  973. </code>
  974. </td>
  975. <td>
  976. <div>
  977. <p>The <code>SecPolicy</code>.</p>
  978. </div>
  979. </td>
  980. </tr>
  981. </tbody>
  982. </table>
  983. </div>
  984. <div>
  985. <h4>Return Value</h4>
  986. <p><code>self</code>, with the policy applied.</p>
  987. </div>
  988. </section>
  989. </div>
  990. </li>
  991. <li class="item">
  992. <div>
  993. <code>
  994. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8evaluateyyKF"></a>
  995. <a name="//apple_ref/swift/Method/evaluate()" class="dashAnchor"></a>
  996. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8evaluateyyKF">evaluate()</a>
  997. </code>
  998. </div>
  999. <div class="height-container">
  1000. <div class="pointer-container"></div>
  1001. <section class="section">
  1002. <div class="pointer"></div>
  1003. <div class="abstract">
  1004. <p>Evaluate <code>self</code>, throwing an <code>Error</code> if evaluation fails.</p>
  1005. <div class="aside aside-throws">
  1006. <p class="aside-title">Throws</p>
  1007. <code>AFError.serverTrustEvaluationFailed</code> with reason <code>.trustValidationFailed</code> and associated error from
  1008. the underlying evaluation.
  1009. </div>
  1010. </div>
  1011. <div class="declaration">
  1012. <h4>Declaration</h4>
  1013. <div class="language">
  1014. <p class="aside-title">Swift</p>
  1015. <pre class="highlight swift"><code><span class="kd">@available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *)</span>
  1016. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">evaluate</span><span class="p">()</span> <span class="k">throws</span></code></pre>
  1017. </div>
  1018. </div>
  1019. </section>
  1020. </div>
  1021. </li>
  1022. <li class="item">
  1023. <div>
  1024. <code>
  1025. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate13errorProducerys5Error_ps5Int32V_So0cD10ResultTypeVtXE_tKF"></a>
  1026. <a name="//apple_ref/swift/Method/validate(errorProducer:)" class="dashAnchor"></a>
  1027. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE8validate13errorProducerys5Error_ps5Int32V_So0cD10ResultTypeVtXE_tKF">validate(errorProducer:<wbr>)</a>
  1028. </code>
  1029. </div>
  1030. <div class="height-container">
  1031. <div class="pointer-container"></div>
  1032. <section class="section">
  1033. <div class="pointer"></div>
  1034. <div class="abstract">
  1035. <p>Validate <code>self</code>, passing any failure values through <code>errorProducer</code>.</p>
  1036. <div class="aside aside-throws">
  1037. <p class="aside-title">Throws</p>
  1038. The <code>Error</code> produced by the <code>errorProducer</code> closure.
  1039. </div>
  1040. </div>
  1041. <div class="declaration">
  1042. <h4>Declaration</h4>
  1043. <div class="language">
  1044. <p class="aside-title">Swift</p>
  1045. <pre class="highlight swift"><code><span class="kd">@available(iOS, introduced: 10, deprecated: 12, renamed: "evaluate(﹚")</span>
  1046. <span class="kd">@available(macOS, introduced: 10.12, deprecated: 10.14, renamed: "evaluate(﹚")</span>
  1047. <span class="kd">@available(tvOS, introduced: 10, deprecated: 12, renamed: "evaluate(﹚")</span>
  1048. <span class="kd">@available(watchOS, introduced: 3, deprecated: 5, renamed: "evaluate(﹚")</span>
  1049. <span class="kd">public</span> <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>
  1050. </div>
  1051. </div>
  1052. <div>
  1053. <h4>Parameters</h4>
  1054. <table class="graybox">
  1055. <tbody>
  1056. <tr>
  1057. <td>
  1058. <code>
  1059. <em>errorProducer</em>
  1060. </code>
  1061. </td>
  1062. <td>
  1063. <div>
  1064. <p>The closure used to transform the failed <code>OSStatus</code> and <code>SecTrustResultType</code> into an
  1065. <code>Error</code>.</p>
  1066. </div>
  1067. </td>
  1068. </tr>
  1069. </tbody>
  1070. </table>
  1071. </div>
  1072. </section>
  1073. </div>
  1074. </li>
  1075. <li class="item">
  1076. <div>
  1077. <code>
  1078. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE21setAnchorCertificatesyySaySo0c11CertificateE0aGKF"></a>
  1079. <a name="//apple_ref/swift/Method/setAnchorCertificates(_:)" class="dashAnchor"></a>
  1080. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE21setAnchorCertificatesyySaySo0c11CertificateE0aGKF">setAnchorCertificates(_:<wbr>)</a>
  1081. </code>
  1082. </div>
  1083. <div class="height-container">
  1084. <div class="pointer-container"></div>
  1085. <section class="section">
  1086. <div class="pointer"></div>
  1087. <div class="abstract">
  1088. <p>Sets a custom certificate chain on <code>self</code>, allowing full validation of a self-signed certificate and its chain.</p>
  1089. <div class="aside aside-throws">
  1090. <p class="aside-title">Throws</p>
  1091. Any error produced when applying the new certificate chain.
  1092. </div>
  1093. </div>
  1094. <div class="declaration">
  1095. <h4>Declaration</h4>
  1096. <div class="language">
  1097. <p class="aside-title">Swift</p>
  1098. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1099. </div>
  1100. </div>
  1101. <div>
  1102. <h4>Parameters</h4>
  1103. <table class="graybox">
  1104. <tbody>
  1105. <tr>
  1106. <td>
  1107. <code>
  1108. <em>certificates</em>
  1109. </code>
  1110. </td>
  1111. <td>
  1112. <div>
  1113. <p>The <code>SecCertificate</code>s to add to the chain.</p>
  1114. </div>
  1115. </td>
  1116. </tr>
  1117. </tbody>
  1118. </table>
  1119. </div>
  1120. </section>
  1121. </div>
  1122. </li>
  1123. <li class="item">
  1124. <div>
  1125. <code>
  1126. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE10publicKeysSaySo0c3KeyE0aGvp"></a>
  1127. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  1128. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE10publicKeysSaySo0c3KeyE0aGvp">publicKeys</a>
  1129. </code>
  1130. </div>
  1131. <div class="height-container">
  1132. <div class="pointer-container"></div>
  1133. <section class="section">
  1134. <div class="pointer"></div>
  1135. <div class="abstract">
  1136. <p>The public keys contained in <code>self</code>.</p>
  1137. </div>
  1138. <div class="declaration">
  1139. <h4>Declaration</h4>
  1140. <div class="language">
  1141. <p class="aside-title">Swift</p>
  1142. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1143. </div>
  1144. </div>
  1145. </section>
  1146. </div>
  1147. </li>
  1148. <li class="item">
  1149. <div>
  1150. <code>
  1151. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE12certificatesSaySo0c11CertificateE0aGvp"></a>
  1152. <a name="//apple_ref/swift/Property/certificates" class="dashAnchor"></a>
  1153. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE12certificatesSaySo0c11CertificateE0aGvp">certificates</a>
  1154. </code>
  1155. </div>
  1156. <div class="height-container">
  1157. <div class="pointer-container"></div>
  1158. <section class="section">
  1159. <div class="pointer"></div>
  1160. <div class="abstract">
  1161. <p>The <code>SecCertificate</code>s contained in <code>self</code>.</p>
  1162. </div>
  1163. <div class="declaration">
  1164. <h4>Declaration</h4>
  1165. <div class="language">
  1166. <p class="aside-title">Swift</p>
  1167. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1168. </div>
  1169. </div>
  1170. </section>
  1171. </div>
  1172. </li>
  1173. <li class="item">
  1174. <div>
  1175. <code>
  1176. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE15certificateDataSay10Foundation0G0VGvp"></a>
  1177. <a name="//apple_ref/swift/Property/certificateData" class="dashAnchor"></a>
  1178. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE15certificateDataSay10Foundation0G0VGvp">certificateData</a>
  1179. </code>
  1180. </div>
  1181. <div class="height-container">
  1182. <div class="pointer-container"></div>
  1183. <section class="section">
  1184. <div class="pointer"></div>
  1185. <div class="abstract">
  1186. <p>The <code>Data</code> values for all certificates contained in <code>self</code>.</p>
  1187. </div>
  1188. <div class="declaration">
  1189. <h4>Declaration</h4>
  1190. <div class="language">
  1191. <p class="aside-title">Swift</p>
  1192. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1193. </div>
  1194. </div>
  1195. </section>
  1196. </div>
  1197. </li>
  1198. <li class="item">
  1199. <div>
  1200. <code>
  1201. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE24performDefaultValidation7forHostySS_tKF"></a>
  1202. <a name="//apple_ref/swift/Method/performDefaultValidation(forHost:)" class="dashAnchor"></a>
  1203. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE24performDefaultValidation7forHostySS_tKF">performDefaultValidation(forHost:<wbr>)</a>
  1204. </code>
  1205. </div>
  1206. <div class="height-container">
  1207. <div class="pointer-container"></div>
  1208. <section class="section">
  1209. <div class="pointer"></div>
  1210. <div class="abstract">
  1211. <p>Validates <code>self</code> after applying <code>SecPolicy.af.default</code>. This evaluation does not validate the hostname.</p>
  1212. <div class="aside aside-throws">
  1213. <p class="aside-title">Throws</p>
  1214. An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.defaultEvaluationFailed</code> reason.
  1215. </div>
  1216. </div>
  1217. <div class="declaration">
  1218. <h4>Declaration</h4>
  1219. <div class="language">
  1220. <p class="aside-title">Swift</p>
  1221. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1222. </div>
  1223. </div>
  1224. <div>
  1225. <h4>Parameters</h4>
  1226. <table class="graybox">
  1227. <tbody>
  1228. <tr>
  1229. <td>
  1230. <code>
  1231. <em>host</em>
  1232. </code>
  1233. </td>
  1234. <td>
  1235. <div>
  1236. <p>The hostname, used only in the error output if validation fails.</p>
  1237. </div>
  1238. </td>
  1239. </tr>
  1240. </tbody>
  1241. </table>
  1242. </div>
  1243. </section>
  1244. </div>
  1245. </li>
  1246. <li class="item">
  1247. <div>
  1248. <code>
  1249. <a name="/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE17performValidation7forHostySS_tKF"></a>
  1250. <a name="//apple_ref/swift/Method/performValidation(forHost:)" class="dashAnchor"></a>
  1251. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo11SecTrustRefaRszlE17performValidation7forHostySS_tKF">performValidation(forHost:<wbr>)</a>
  1252. </code>
  1253. </div>
  1254. <div class="height-container">
  1255. <div class="pointer-container"></div>
  1256. <section class="section">
  1257. <div class="pointer"></div>
  1258. <div class="abstract">
  1259. <p>Validates <code>self</code> after applying <code>SecPolicy.af.hostname(host)</code>, which performs the default validation as well as
  1260. hostname validation.</p>
  1261. <div class="aside aside-throws">
  1262. <p class="aside-title">Throws</p>
  1263. An <code>AFError.serverTrustEvaluationFailed</code> instance with a <code>.defaultEvaluationFailed</code> reason.
  1264. </div>
  1265. </div>
  1266. <div class="declaration">
  1267. <h4>Declaration</h4>
  1268. <div class="language">
  1269. <p class="aside-title">Swift</p>
  1270. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1271. </div>
  1272. </div>
  1273. <div>
  1274. <h4>Parameters</h4>
  1275. <table class="graybox">
  1276. <tbody>
  1277. <tr>
  1278. <td>
  1279. <code>
  1280. <em>host</em>
  1281. </code>
  1282. </td>
  1283. <td>
  1284. <div>
  1285. <p>The hostname to use in the validation.</p>
  1286. </div>
  1287. </td>
  1288. </tr>
  1289. </tbody>
  1290. </table>
  1291. </div>
  1292. </section>
  1293. </div>
  1294. </li>
  1295. </ul>
  1296. </div>
  1297. <div class="task-group">
  1298. <div class="task-name-container">
  1299. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecPolicy%60"></a>
  1300. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == `SecPolicy`" class="dashAnchor"></a>
  1301. <div class="section-name-container">
  1302. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecPolicy%60"></a>
  1303. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == <code>SecPolicy</code></span>
  1304. </h3>
  1305. </div>
  1306. </div>
  1307. <ul class="item-container">
  1308. <li class="item">
  1309. <div>
  1310. <code>
  1311. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE7defaultAEvpZ"></a>
  1312. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  1313. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE7defaultAEvpZ">default</a>
  1314. </code>
  1315. </div>
  1316. <div class="height-container">
  1317. <div class="pointer-container"></div>
  1318. <section class="section">
  1319. <div class="pointer"></div>
  1320. <div class="abstract">
  1321. <p>Creates a <code>SecPolicy</code> instance which will validate server certificates but not require a host name match.</p>
  1322. </div>
  1323. <div class="declaration">
  1324. <h4>Declaration</h4>
  1325. <div class="language">
  1326. <p class="aside-title">Swift</p>
  1327. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1328. </div>
  1329. </div>
  1330. </section>
  1331. </div>
  1332. </li>
  1333. <li class="item">
  1334. <div>
  1335. <code>
  1336. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE8hostnameyAESSFZ"></a>
  1337. <a name="//apple_ref/swift/Method/hostname(_:)" class="dashAnchor"></a>
  1338. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE8hostnameyAESSFZ">hostname(_:<wbr>)</a>
  1339. </code>
  1340. </div>
  1341. <div class="height-container">
  1342. <div class="pointer-container"></div>
  1343. <section class="section">
  1344. <div class="pointer"></div>
  1345. <div class="abstract">
  1346. <p>Creates a <code>SecPolicy</code> instance which will validate server certificates and much match the provided hostname.</p>
  1347. </div>
  1348. <div class="declaration">
  1349. <h4>Declaration</h4>
  1350. <div class="language">
  1351. <p class="aside-title">Swift</p>
  1352. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1353. </div>
  1354. </div>
  1355. <div>
  1356. <h4>Parameters</h4>
  1357. <table class="graybox">
  1358. <tbody>
  1359. <tr>
  1360. <td>
  1361. <code>
  1362. <em>hostname</em>
  1363. </code>
  1364. </td>
  1365. <td>
  1366. <div>
  1367. <p>The hostname to validate against.</p>
  1368. </div>
  1369. </td>
  1370. </tr>
  1371. </tbody>
  1372. </table>
  1373. </div>
  1374. <div>
  1375. <h4>Return Value</h4>
  1376. <p>The <code>SecPolicy</code>.</p>
  1377. </div>
  1378. </section>
  1379. </div>
  1380. </li>
  1381. <li class="item">
  1382. <div>
  1383. <code>
  1384. <a name="/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE10revocation7optionsAeA24RevocationTrustEvaluatorC7OptionsV_tKFZ"></a>
  1385. <a name="//apple_ref/swift/Method/revocation(options:)" class="dashAnchor"></a>
  1386. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo12SecPolicyRefaRszlE10revocation7optionsAeA24RevocationTrustEvaluatorC7OptionsV_tKFZ">revocation(options:<wbr>)</a>
  1387. </code>
  1388. </div>
  1389. <div class="height-container">
  1390. <div class="pointer-container"></div>
  1391. <section class="section">
  1392. <div class="pointer"></div>
  1393. <div class="abstract">
  1394. <p>Creates a <code>SecPolicy</code> which checks the revocation of certificates.</p>
  1395. <div class="aside aside-throws">
  1396. <p class="aside-title">Throws</p>
  1397. <p>An <code>AFError.serverTrustEvaluationFailed</code> error with reason <code>.revocationPolicyCreationFailed</code>
  1398. if the policy cannot be created.</p>
  1399. </div>
  1400. </div>
  1401. <div class="declaration">
  1402. <h4>Declaration</h4>
  1403. <div class="language">
  1404. <p class="aside-title">Swift</p>
  1405. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1406. </div>
  1407. </div>
  1408. <div>
  1409. <h4>Parameters</h4>
  1410. <table class="graybox">
  1411. <tbody>
  1412. <tr>
  1413. <td>
  1414. <code>
  1415. <em>options</em>
  1416. </code>
  1417. </td>
  1418. <td>
  1419. <div>
  1420. <p>The <code><a href="../Classes/RevocationTrustEvaluator/Options.html">RevocationTrustEvaluator.Options</a></code> for evaluation.</p>
  1421. </div>
  1422. </td>
  1423. </tr>
  1424. </tbody>
  1425. </table>
  1426. </div>
  1427. <div>
  1428. <h4>Return Value</h4>
  1429. <p>The <code>SecPolicy</code>.</p>
  1430. </div>
  1431. </section>
  1432. </div>
  1433. </li>
  1434. </ul>
  1435. </div>
  1436. <div class="task-group">
  1437. <div class="task-name-container">
  1438. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%5B%60SecCertificate%60%5D"></a>
  1439. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == [`SecCertificate`]" class="dashAnchor"></a>
  1440. <div class="section-name-container">
  1441. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%5B%60SecCertificate%60%5D"></a>
  1442. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == [<code>SecCertificate</code>]</span>
  1443. </h3>
  1444. </div>
  1445. </div>
  1446. <ul class="item-container">
  1447. <li class="item">
  1448. <div>
  1449. <code>
  1450. <a name="/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE4dataSay10Foundation4DataVGvp"></a>
  1451. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  1452. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE4dataSay10Foundation4DataVGvp">data</a>
  1453. </code>
  1454. </div>
  1455. <div class="height-container">
  1456. <div class="pointer-container"></div>
  1457. <section class="section">
  1458. <div class="pointer"></div>
  1459. <div class="abstract">
  1460. <p>All <code>Data</code> values for the contained <code>SecCertificate</code>s.</p>
  1461. </div>
  1462. <div class="declaration">
  1463. <h4>Declaration</h4>
  1464. <div class="language">
  1465. <p class="aside-title">Swift</p>
  1466. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1467. </div>
  1468. </div>
  1469. </section>
  1470. </div>
  1471. </li>
  1472. <li class="item">
  1473. <div>
  1474. <code>
  1475. <a name="/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE10publicKeysSaySo0c3KeyE0aGvp"></a>
  1476. <a name="//apple_ref/swift/Property/publicKeys" class="dashAnchor"></a>
  1477. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASaySo17SecCertificateRefaGRszlE10publicKeysSaySo0c3KeyE0aGvp">publicKeys</a>
  1478. </code>
  1479. </div>
  1480. <div class="height-container">
  1481. <div class="pointer-container"></div>
  1482. <section class="section">
  1483. <div class="pointer"></div>
  1484. <div class="abstract">
  1485. <p>All public <code>SecKey</code> values for the contained <code>SecCertificate</code>s.</p>
  1486. </div>
  1487. <div class="declaration">
  1488. <h4>Declaration</h4>
  1489. <div class="language">
  1490. <p class="aside-title">Swift</p>
  1491. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1492. </div>
  1493. </div>
  1494. </section>
  1495. </div>
  1496. </li>
  1497. </ul>
  1498. </div>
  1499. <div class="task-group">
  1500. <div class="task-name-container">
  1501. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecCertificate%60"></a>
  1502. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == `SecCertificate`" class="dashAnchor"></a>
  1503. <div class="section-name-container">
  1504. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecCertificate%60"></a>
  1505. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == <code>SecCertificate</code></span>
  1506. </h3>
  1507. </div>
  1508. </div>
  1509. <ul class="item-container">
  1510. <li class="item">
  1511. <div>
  1512. <code>
  1513. <a name="/s:9Alamofire0A9ExtensionVAASo17SecCertificateRefaRszlE9publicKeySo0cgE0aSgvp"></a>
  1514. <a name="//apple_ref/swift/Property/publicKey" class="dashAnchor"></a>
  1515. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo17SecCertificateRefaRszlE9publicKeySo0cgE0aSgvp">publicKey</a>
  1516. </code>
  1517. </div>
  1518. <div class="height-container">
  1519. <div class="pointer-container"></div>
  1520. <section class="section">
  1521. <div class="pointer"></div>
  1522. <div class="abstract">
  1523. <p>The public key for <code>self</code>, if it can be extracted.</p>
  1524. <div class="aside aside-note">
  1525. <p class="aside-title">Note</p>
  1526. On 2020 OSes and newer, only RSA and ECDSA keys are supported.
  1527. </div>
  1528. </div>
  1529. <div class="declaration">
  1530. <h4>Declaration</h4>
  1531. <div class="language">
  1532. <p class="aside-title">Swift</p>
  1533. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1534. </div>
  1535. </div>
  1536. </section>
  1537. </div>
  1538. </li>
  1539. </ul>
  1540. </div>
  1541. <div class="task-group">
  1542. <div class="task-name-container">
  1543. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60OSStatus%60"></a>
  1544. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == `OSStatus`" class="dashAnchor"></a>
  1545. <div class="section-name-container">
  1546. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60OSStatus%60"></a>
  1547. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == <code>OSStatus</code></span>
  1548. </h3>
  1549. </div>
  1550. </div>
  1551. <ul class="item-container">
  1552. <li class="item">
  1553. <div>
  1554. <code>
  1555. <a name="/s:9Alamofire0A9ExtensionVAAs5Int32VRszlE9isSuccessSbvp"></a>
  1556. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  1557. <a class="token" href="#/s:9Alamofire0A9ExtensionVAAs5Int32VRszlE9isSuccessSbvp">isSuccess</a>
  1558. </code>
  1559. </div>
  1560. <div class="height-container">
  1561. <div class="pointer-container"></div>
  1562. <section class="section">
  1563. <div class="pointer"></div>
  1564. <div class="abstract">
  1565. <p>Returns whether <code>self</code> is <code>errSecSuccess</code>.</p>
  1566. </div>
  1567. <div class="declaration">
  1568. <h4>Declaration</h4>
  1569. <div class="language">
  1570. <p class="aside-title">Swift</p>
  1571. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1572. </div>
  1573. </div>
  1574. </section>
  1575. </div>
  1576. </li>
  1577. </ul>
  1578. </div>
  1579. <div class="task-group">
  1580. <div class="task-name-container">
  1581. <a name="/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecTrustResultType%60"></a>
  1582. <a name="//apple_ref/swift/Section/Available where `ExtendedType` == `SecTrustResultType`" class="dashAnchor"></a>
  1583. <div class="section-name-container">
  1584. <a class="section-name-link" href="#/Available%20where%20%60ExtendedType%60%20%3D%3D%20%60SecTrustResultType%60"></a>
  1585. <h3 class="section-name"><span>Available where <code>ExtendedType</code> == <code>SecTrustResultType</code></span>
  1586. </h3>
  1587. </div>
  1588. </div>
  1589. <ul class="item-container">
  1590. <li class="item">
  1591. <div>
  1592. <code>
  1593. <a name="/s:9Alamofire0A9ExtensionVAASo18SecTrustResultTypeVRszlE9isSuccessSbvp"></a>
  1594. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  1595. <a class="token" href="#/s:9Alamofire0A9ExtensionVAASo18SecTrustResultTypeVRszlE9isSuccessSbvp">isSuccess</a>
  1596. </code>
  1597. </div>
  1598. <div class="height-container">
  1599. <div class="pointer-container"></div>
  1600. <section class="section">
  1601. <div class="pointer"></div>
  1602. <div class="abstract">
  1603. <p>Returns whether <code>self</code> is <code>.unspecified</code> or <code>.proceed</code>.</p>
  1604. </div>
  1605. <div class="declaration">
  1606. <h4>Declaration</h4>
  1607. <div class="language">
  1608. <p class="aside-title">Swift</p>
  1609. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  1610. </div>
  1611. </div>
  1612. </section>
  1613. </div>
  1614. </li>
  1615. </ul>
  1616. </div>
  1617. </div>
  1618. </section>
  1619. </article>
  1620. </div>
  1621. <section class="footer">
  1622. <p>&copy; 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-03-30)</p>
  1623. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1624. </section>
  1625. </body>
  1626. </html>