Domů Procházet Nápověda
Přihlásit se
mirror
/
Alamofire
zrcadlo https://github.com/Alamofire/Alamofire.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: ba3dc4354d
Větve Značky
Alamofire
/
docs
/
docsets
/
Alamofire.docset
/
Contents
/
Resources
/
Documents
/
Protocols
/
Authenticator.html

Authenticator.html 54 KB
Historie Surový

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3.   <head>
    4. 

  4.     <title>Authenticator Protocol Reference</title>
    5. 

  5.     <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    6. 

  6.     <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    7. 

  7.     <meta charset="utf-8">
    8. 

  8.     <script src="../js/jquery.min.js" defer></script>
    9. 

  9.     <script src="../js/jazzy.js" defer></script>
    10. 

  10.     
    11. 

  11.     <script src="../js/lunr.min.js" defer></script>
    12. 

  12.     <script src="../js/typeahead.jquery.js" defer></script>
    13. 

  13.     <script src="../js/jazzy.search.js" defer></script>
    14. 

  14.   </head>
    15. 

  15.   <body>
    16. 

  16. 

  17.     <a name="//apple_ref/swift/Protocol/Authenticator" class="dashAnchor"></a>
    18. 

  18. 

  19.     <a title="Authenticator Protocol Reference"></a>
    20. 

  20. 

  21.     <header class="header">
    22. 

  22.       <p class="header-col header-col--primary">
    23. 

  23.         <a class="header-link" href="../index.html">
    24. 

  24.           Alamofire 5.9.1 Docs
    25. 

  25.         </a>
    26. 

  26.          (96% documented)
    27. 

  27.       </p>
    28. 

  28.     
    29. 

  29.       <div class="header-col--secondary">
    30. 

  30.         <form role="search" action="../search.json">
    31. 

  31.           <input type="text" placeholder="Search documentation" data-typeahead>
    32. 

  32.         </form>
    33. 

  33.       </div>
    34. 

  34.     
    35. 

  35.         <p class="header-col header-col--secondary">
    36. 

  36.           <a class="header-link" href="https://github.com/Alamofire/Alamofire">
    37. 

  37.             <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
    38. 

  38.             View on GitHub
    39. 

  39.           </a>
    40. 

  40.         </p>
    41. 

  41.     
    42. 

  42.         <p class="header-col header-col--secondary">
    43. 

  43.           <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
    44. 

  44.             <img class="header-icon" src="../img/dash.png" alt="Dash"/>
    45. 

  45.             Install in Dash
    46. 

  46.           </a>
    47. 

  47.         </p>
    48. 

  48.     </header>
    49. 

  49. 

  50.     <p class="breadcrumbs">
    51. 

  51.       <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
    52. 

  52.       <img class="carat" src="../img/carat.png" alt=""/>
    53. 

  53.       Authenticator Protocol Reference
    54. 

  54.     </p>
    55. 

  55. 

  56.     <div class="content-wrapper">
    57. 

  57.       <nav class="navigation">
    58. 

  58.         <ul class="nav-groups">
    59. 

  59.           <li class="nav-group-name">
    60. 

  60.             <a class="nav-group-name-link" href="../Classes.html">Classes</a>
    61. 

  61.             <ul class="nav-group-tasks">
    62. 

  62.               <li class="nav-group-task">
    63. 

  63.                 <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
    64. 

  64.               </li>
    65. 

  65.               <li class="nav-group-task">
    66. 

  66.                 <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
    67. 

  67.               </li>
    68. 

  68.               <li class="nav-group-task">
    69. 

  69.                 <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
    70. 

  70.               </li>
    71. 

  71.               <li class="nav-group-task">
    72. 

  72.                 <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
    73. 

  73.               </li>
    74. 

  74.               <li class="nav-group-task">
    75. 

  75.                 <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
    76. 

  76.               </li>
    77. 

  77.               <li class="nav-group-task">
    78. 

  78.                 <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
    79. 

  79.               </li>
    80. 

  80.               <li class="nav-group-task">
    81. 

  81.                 <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
    82. 

  82.               </li>
    83. 

  83.               <li class="nav-group-task">
    84. 

  84.                 <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
    85. 

  85.               </li>
    86. 

  86.               <li class="nav-group-task">
    87. 

  87.                 <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
    88. 

  88.               </li>
    89. 

  89.               <li class="nav-group-task">
    90. 

  90.                 <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
    91. 

  91.               </li>
    92. 

  92.               <li class="nav-group-task">
    93. 

  93.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
    94. 

  94.               </li>
    95. 

  95.               <li class="nav-group-task">
    96. 

  96.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
    97. 

  97.               </li>
    98. 

  98.               <li class="nav-group-task">
    99. 

  99.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
    100. 

  100.               </li>
    101. 

  101.               <li class="nav-group-task">
    102. 

  102.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
    103. 

  103.               </li>
    104. 

  104.               <li class="nav-group-task">
    105. 

  105.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
    106. 

  106.               </li>
    107. 

  107.               <li class="nav-group-task">
    108. 

  108.                 <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
    109. 

  109.               </li>
    110. 

  110.               <li class="nav-group-task">
    111. 

  111.                 <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
    112. 

  112.               </li>
    113. 

  113.               <li class="nav-group-task">
    114. 

  114.                 <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
    115. 

  115.               </li>
    116. 

  116.               <li class="nav-group-task">
    117. 

  117.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
    118. 

  118.               </li>
    119. 

  119.               <li class="nav-group-task">
    120. 

  120.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
    121. 

  121.               </li>
    122. 

  122.               <li class="nav-group-task">
    123. 

  123.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
    124. 

  124.               </li>
    125. 

  125.               <li class="nav-group-task">
    126. 

  126.                 <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
    127. 

  127.               </li>
    128. 

  128.               <li class="nav-group-task">
    129. 

  129.                 <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
    130. 

  130.               </li>
    131. 

  131.               <li class="nav-group-task">
    132. 

  132.                 <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
    133. 

  133.               </li>
    134. 

  134.               <li class="nav-group-task">
    135. 

  135.                 <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
    136. 

  136.               </li>
    137. 

  137.               <li class="nav-group-task">
    138. 

  138.                 <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
    139. 

  139.               </li>
    140. 

  140.               <li class="nav-group-task">
    141. 

  141.                 <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
    142. 

  142.               </li>
    143. 

  143.               <li class="nav-group-task">
    144. 

  144.                 <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
    145. 

  145.               </li>
    146. 

  146.               <li class="nav-group-task">
    147. 

  147.                 <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
    148. 

  148.               </li>
    149. 

  149.               <li class="nav-group-task">
    150. 

  150.                 <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
    151. 

  151.               </li>
    152. 

  152.               <li class="nav-group-task">
    153. 

  153.                 <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
    154. 

  154.               </li>
    155. 

  155.               <li class="nav-group-task">
    156. 

  156.                 <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
    157. 

  157.               </li>
    158. 

  158.               <li class="nav-group-task">
    159. 

  159.                 <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
    160. 

  160.               </li>
    161. 

  161.               <li class="nav-group-task">
    162. 

  162.                 <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
    163. 

  163.               </li>
    164. 

  164.               <li class="nav-group-task">
    165. 

  165.                 <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
    166. 

  166.               </li>
    167. 

  167.               <li class="nav-group-task">
    168. 

  168.                 <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
    169. 

  169.               </li>
    170. 

  170.               <li class="nav-group-task">
    171. 

  171.                 <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
    172. 

  172.               </li>
    173. 

  173.               <li class="nav-group-task">
    174. 

  174.                 <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
    175. 

  175.               </li>
    176. 

  176.               <li class="nav-group-task">
    177. 

  177.                 <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
    178. 

  178.               </li>
    179. 

  179.               <li class="nav-group-task">
    180. 

  180.                 <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
    181. 

  181.               </li>
    182. 

  182.               <li class="nav-group-task">
    183. 

  183.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
    184. 

  184.               </li>
    185. 

  185.               <li class="nav-group-task">
    186. 

  186.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
    187. 

  187.               </li>
    188. 

  188.               <li class="nav-group-task">
    189. 

  189.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
    190. 

  190.               </li>
    191. 

  191.               <li class="nav-group-task">
    192. 

  192.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
    193. 

  193.               </li>
    194. 

  194.               <li class="nav-group-task">
    195. 

  195.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
    196. 

  196.               </li>
    197. 

  197.               <li class="nav-group-task">
    198. 

  198.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
    199. 

  199.               </li>
    200. 

  200.               <li class="nav-group-task">
    201. 

  201.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
    202. 

  202.               </li>
    203. 

  203.               <li class="nav-group-task">
    204. 

  204.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
    205. 

  205.               </li>
    206. 

  206.               <li class="nav-group-task">
    207. 

  207.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
    208. 

  208.               </li>
    209. 

  209.               <li class="nav-group-task">
    210. 

  210.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
    211. 

  211.               </li>
    212. 

  212.               <li class="nav-group-task">
    213. 

  213.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
    214. 

  214.               </li>
    215. 

  215.               <li class="nav-group-task">
    216. 

  216.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
    217. 

  217.               </li>
    218. 

  218.               <li class="nav-group-task">
    219. 

  219.                 <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
    220. 

  220.               </li>
    221. 

  221.               <li class="nav-group-task">
    222. 

  222.                 <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
    223. 

  223.               </li>
    224. 

  224.             </ul>
    225. 

  225.           </li>
    226. 

  226.           <li class="nav-group-name">
    227. 

  227.             <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
    228. 

  228.             <ul class="nav-group-tasks">
    229. 

  229.               <li class="nav-group-task">
    230. 

  230.                 <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
    231. 

  231.               </li>
    232. 

  232.             </ul>
    233. 

  233.           </li>
    234. 

  234.           <li class="nav-group-name">
    235. 

  235.             <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
    236. 

  236.             <ul class="nav-group-tasks">
    237. 

  237.               <li class="nav-group-task">
    238. 

  238.                 <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
    239. 

  239.               </li>
    240. 

  240.               <li class="nav-group-task">
    241. 

  241.                 <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
    242. 

  242.               </li>
    243. 

  243.               <li class="nav-group-task">
    244. 

  244.                 <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
    245. 

  245.               </li>
    246. 

  246.               <li class="nav-group-task">
    247. 

  247.                 <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
    248. 

  248.               </li>
    249. 

  249.               <li class="nav-group-task">
    250. 

  250.                 <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
    251. 

  251.               </li>
    252. 

  252.               <li class="nav-group-task">
    253. 

  253.                 <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
    254. 

  254.               </li>
    255. 

  255.               <li class="nav-group-task">
    256. 

  256.                 <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
    257. 

  257.               </li>
    258. 

  258.               <li class="nav-group-task">
    259. 

  259.                 <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
    260. 

  260.               </li>
    261. 

  261.               <li class="nav-group-task">
    262. 

  262.                 <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
    263. 

  263.               </li>
    264. 

  264.               <li class="nav-group-task">
    265. 

  265.                 <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
    266. 

  266.               </li>
    267. 

  267.               <li class="nav-group-task">
    268. 

  268.                 <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
    269. 

  269.               </li>
    270. 

  270.               <li class="nav-group-task">
    271. 

  271.                 <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
    272. 

  272.               </li>
    273. 

  273.             </ul>
    274. 

  274.           </li>
    275. 

  275.           <li class="nav-group-name">
    276. 

  276.             <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
    277. 

  277.             <ul class="nav-group-tasks">
    278. 

  278.               <li class="nav-group-task">
    279. 

  279.                 <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
    280. 

  280.               </li>
    281. 

  281.               <li class="nav-group-task">
    282. 

  282.                 <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
    283. 

  283.               </li>
    284. 

  284.               <li class="nav-group-task">
    285. 

  285.                 <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
    286. 

  286.               </li>
    287. 

  287.               <li class="nav-group-task">
    288. 

  288.                 <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
    289. 

  289.               </li>
    290. 

  290.               <li class="nav-group-task">
    291. 

  291.                 <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
    292. 

  292.               </li>
    293. 

  293.               <li class="nav-group-task">
    294. 

  294.                 <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
    295. 

  295.               </li>
    296. 

  296.               <li class="nav-group-task">
    297. 

  297.                 <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
    298. 

  298.               </li>
    299. 

  299.               <li class="nav-group-task">
    300. 

  300.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
    301. 

  301.               </li>
    302. 

  302.               <li class="nav-group-task">
    303. 

  303.                 <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
    304. 

  304.               </li>
    305. 

  305.               <li class="nav-group-task">
    306. 

  306.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
    307. 

  307.               </li>
    308. 

  308.               <li class="nav-group-task">
    309. 

  309.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
    310. 

  310.               </li>
    311. 

  311.               <li class="nav-group-task">
    312. 

  312.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
    313. 

  313.               </li>
    314. 

  314.               <li class="nav-group-task">
    315. 

  315.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
    316. 

  316.               </li>
    317. 

  317.               <li class="nav-group-task">
    318. 

  318.                 <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
    319. 

  319.               </li>
    320. 

  320.               <li class="nav-group-task">
    321. 

  321.                 <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
    322. 

  322.               </li>
    323. 

  323.               <li class="nav-group-task">
    324. 

  324.                 <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
    325. 

  325.               </li>
    326. 

  326.               <li class="nav-group-task">
    327. 

  327.                 <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
    328. 

  328.               </li>
    329. 

  329.               <li class="nav-group-task">
    330. 

  330.                 <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
    331. 

  331.               </li>
    332. 

  332.               <li class="nav-group-task">
    333. 

  333.                 <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
    334. 

  334.               </li>
    335. 

  335.             </ul>
    336. 

  336.           </li>
    337. 

  337.           <li class="nav-group-name">
    338. 

  338.             <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
    339. 

  339.             <ul class="nav-group-tasks">
    340. 

  340.               <li class="nav-group-task">
    341. 

  341.                 <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
    342. 

  342.               </li>
    343. 

  343.               <li class="nav-group-task">
    344. 

  344.                 <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
    345. 

  345.               </li>
    346. 

  346.               <li class="nav-group-task">
    347. 

  347.                 <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
    348. 

  348.               </li>
    349. 

  349.               <li class="nav-group-task">
    350. 

  350.                 <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
    351. 

  351.               </li>
    352. 

  352.               <li class="nav-group-task">
    353. 

  353.                 <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
    354. 

  354.               </li>
    355. 

  355.               <li class="nav-group-task">
    356. 

  356.                 <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
    357. 

  357.               </li>
    358. 

  358.               <li class="nav-group-task">
    359. 

  359.                 <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
    360. 

  360.               </li>
    361. 

  361.               <li class="nav-group-task">
    362. 

  362.                 <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
    363. 

  363.               </li>
    364. 

  364.               <li class="nav-group-task">
    365. 

  365.                 <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
    366. 

  366.               </li>
    367. 

  367.               <li class="nav-group-task">
    368. 

  368.                 <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
    369. 

  369.               </li>
    370. 

  370.               <li class="nav-group-task">
    371. 

  371.                 <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
    372. 

  372.               </li>
    373. 

  373.               <li class="nav-group-task">
    374. 

  374.                 <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
    375. 

  375.               </li>
    376. 

  376.               <li class="nav-group-task">
    377. 

  377.                 <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
    378. 

  378.               </li>
    379. 

  379.               <li class="nav-group-task">
    380. 

  380.                 <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
    381. 

  381.               </li>
    382. 

  382.               <li class="nav-group-task">
    383. 

  383.                 <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
    384. 

  384.               </li>
    385. 

  385.               <li class="nav-group-task">
    386. 

  386.                 <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
    387. 

  387.               </li>
    388. 

  388.               <li class="nav-group-task">
    389. 

  389.                 <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
    390. 

  390.               </li>
    391. 

  391.               <li class="nav-group-task">
    392. 

  392.                 <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
    393. 

  393.               </li>
    394. 

  394.               <li class="nav-group-task">
    395. 

  395.                 <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
    396. 

  396.               </li>
    397. 

  397.               <li class="nav-group-task">
    398. 

  398.                 <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
    399. 

  399.               </li>
    400. 

  400.               <li class="nav-group-task">
    401. 

  401.                 <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
    402. 

  402.               </li>
    403. 

  403.               <li class="nav-group-task">
    404. 

  404.                 <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
    405. 

  405.               </li>
    406. 

  406.               <li class="nav-group-task">
    407. 

  407.                 <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
    408. 

  408.               </li>
    409. 

  409.               <li class="nav-group-task">
    410. 

  410.                 <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
    411. 

  411.               </li>
    412. 

  412.               <li class="nav-group-task">
    413. 

  413.                 <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
    414. 

  414.               </li>
    415. 

  415.             </ul>
    416. 

  416.           </li>
    417. 

  417.           <li class="nav-group-name">
    418. 

  418.             <a class="nav-group-name-link" href="../Structs.html">Structures</a>
    419. 

  419.             <ul class="nav-group-tasks">
    420. 

  420.               <li class="nav-group-task">
    421. 

  421.                 <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
    422. 

  422.               </li>
    423. 

  423.               <li class="nav-group-task">
    424. 

  424.                 <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
    425. 

  425.               </li>
    426. 

  426.               <li class="nav-group-task">
    427. 

  427.                 <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
    428. 

  428.               </li>
    429. 

  429.               <li class="nav-group-task">
    430. 

  430.                 <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
    431. 

  431.               </li>
    432. 

  432.               <li class="nav-group-task">
    433. 

  433.                 <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
    434. 

  434.               </li>
    435. 

  435.               <li class="nav-group-task">
    436. 

  436.                 <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
    437. 

  437.               </li>
    438. 

  438.               <li class="nav-group-task">
    439. 

  439.                 <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
    440. 

  440.               </li>
    441. 

  441.               <li class="nav-group-task">
    442. 

  442.                 <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
    443. 

  443.               </li>
    444. 

  444.               <li class="nav-group-task">
    445. 

  445.                 <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
    446. 

  446.               </li>
    447. 

  447.               <li class="nav-group-task">
    448. 

  448.                 <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
    449. 

  449.               </li>
    450. 

  450.               <li class="nav-group-task">
    451. 

  451.                 <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
    452. 

  452.               </li>
    453. 

  453.               <li class="nav-group-task">
    454. 

  454.                 <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
    455. 

  455.               </li>
    456. 

  456.               <li class="nav-group-task">
    457. 

  457.                 <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
    458. 

  458.               </li>
    459. 

  459.               <li class="nav-group-task">
    460. 

  460.                 <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
    461. 

  461.               </li>
    462. 

  462.               <li class="nav-group-task">
    463. 

  463.                 <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
    464. 

  464.               </li>
    465. 

  465.               <li class="nav-group-task">
    466. 

  466.                 <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
    467. 

  467.               </li>
    468. 

  468.               <li class="nav-group-task">
    469. 

  469.                 <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
    470. 

  470.               </li>
    471. 

  471.               <li class="nav-group-task">
    472. 

  472.                 <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
    473. 

  473.               </li>
    474. 

  474.               <li class="nav-group-task">
    475. 

  475.                 <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
    476. 

  476.               </li>
    477. 

  477.               <li class="nav-group-task">
    478. 

  478.                 <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
    479. 

  479.               </li>
    480. 

  480.               <li class="nav-group-task">
    481. 

  481.                 <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
    482. 

  482.               </li>
    483. 

  483.               <li class="nav-group-task">
    484. 

  484.                 <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
    485. 

  485.               </li>
    486. 

  486.               <li class="nav-group-task">
    487. 

  487.                 <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
    488. 

  488.               </li>
    489. 

  489.               <li class="nav-group-task">
    490. 

  490.                 <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
    491. 

  491.               </li>
    492. 

  492.               <li class="nav-group-task">
    493. 

  493.                 <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
    494. 

  494.               </li>
    495. 

  495.               <li class="nav-group-task">
    496. 

  496.                 <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
    497. 

  497.               </li>
    498. 

  498.               <li class="nav-group-task">
    499. 

  499.                 <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
    500. 

  500.               </li>
    501. 

  501.               <li class="nav-group-task">
    502. 

  502.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
    503. 

  503.               </li>
    504. 

  504.               <li class="nav-group-task">
    505. 

  505.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
    506. 

  506.               </li>
    507. 

  507.               <li class="nav-group-task">
    508. 

  508.                 <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
    509. 

  509.               </li>
    510. 

  510.               <li class="nav-group-task">
    511. 

  511.                 <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
    512. 

  512.               </li>
    513. 

  513.               <li class="nav-group-task">
    514. 

  514.                 <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
    515. 

  515.               </li>
    516. 

  516.               <li class="nav-group-task">
    517. 

  517.                 <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
    518. 

  518.               </li>
    519. 

  519.               <li class="nav-group-task">
    520. 

  520.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
    521. 

  521.               </li>
    522. 

  522.               <li class="nav-group-task">
    523. 

  523.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
    524. 

  524.               </li>
    525. 

  525.               <li class="nav-group-task">
    526. 

  526.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
    527. 

  527.               </li>
    528. 

  528.               <li class="nav-group-task">
    529. 

  529.                 <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
    530. 

  530.               </li>
    531. 

  531.             </ul>
    532. 

  532.           </li>
    533. 

  533.           <li class="nav-group-name">
    534. 

  534.             <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
    535. 

  535.             <ul class="nav-group-tasks">
    536. 

  536.               <li class="nav-group-task">
    537. 

  537.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
    538. 

  538.               </li>
    539. 

  539.               <li class="nav-group-task">
    540. 

  540.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
    541. 

  541.               </li>
    542. 

  542.               <li class="nav-group-task">
    543. 

  543.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
    544. 

  544.               </li>
    545. 

  545.               <li class="nav-group-task">
    546. 

  546.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
    547. 

  547.               </li>
    548. 

  548.               <li class="nav-group-task">
    549. 

  549.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
    550. 

  550.               </li>
    551. 

  551.               <li class="nav-group-task">
    552. 

  552.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
    553. 

  553.               </li>
    554. 

  554.               <li class="nav-group-task">
    555. 

  555.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
    556. 

  556.               </li>
    557. 

  557.             </ul>
    558. 

  558.           </li>
    559. 

  559.         </ul>
    560. 

  560.       </nav>
    561. 

  561.       <article class="main-content">
    562. 

  562. 

  563.         <section class="section">
    564. 

  564.           <div class="section-content top-matter">
    565. 

  565.             <h1>Authenticator</h1>
    566. 

  566.               <div class="declaration">
    567. 

  567.                 <div class="language">
    568. 

  568.                   
    569. 

  569.                   <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Authenticator</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
    570. 

  570. 

  571.                 </div>
    572. 

  572.               </div>
    573. 

  573.             <p>Types adopting the <code>Authenticator</code> protocol can be used to authenticate <code>URLRequest</code>s with an
    574. 

  574. <code><a href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a></code> as well as refresh the <code><a href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a></code> when required.</p>
    575. 

  575. 

  576.           </div>
    577. 

  577.         </section>
    578. 

  578. 

  579.         <section class="section">
    580. 

  580.           <div class="section-content">
    581. 

  581.             <div class="task-group">
    582. 

  582.               <ul class="item-container">
    583. 

  583.                 <li class="item">
    584. 

  584.                   <div>
    585. 

  585.                     <code>
    586. 

  586.                     <a name="/s:9Alamofire13AuthenticatorP10CredentialQa"></a>
    587. 

  587.                     <a name="//apple_ref/swift/Alias/Credential" class="dashAnchor"></a>
    588. 

  588.                     <a class="token" href="#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a>
    589. 

  589.                     </code>
    590. 

  590.                   </div>
    591. 

  591.                   <div class="height-container">
    592. 

  592.                     <div class="pointer-container"></div>
    593. 

  593.                     <section class="section">
    594. 

  594.                       <div class="pointer"></div>
    595. 

  595.                       <div class="abstract">
    596. 

  596.                         <p>The type of credential associated with the <code>Authenticator</code> instance.</p>
    597. 

  597. 

  598.                       </div>
    599. 

  599.                       <div class="declaration">
    600. 

  600.                         <h4>Declaration</h4>
    601. 

  601.                         <div class="language">
    602. 

  602.                           <p class="aside-title">Swift</p>
    603. 

  603.                           <pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">Credential</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a></span></code></pre>
    604. 

  604. 

  605.                         </div>
    606. 

  606.                       </div>
    607. 

  607.                     </section>
    608. 

  608.                   </div>
    609. 

  609.                 </li>
    610. 

  610.                 <li class="item">
    611. 

  611.                   <div>
    612. 

  612.                     <code>
    613. 

  613.                     <a name="/s:9Alamofire13AuthenticatorP5apply_2toy10CredentialQz_10Foundation10URLRequestVztF"></a>
    614. 

  614.                     <a name="//apple_ref/swift/Method/apply(_:to:)" class="dashAnchor"></a>
    615. 

  615.                     <a class="token" href="#/s:9Alamofire13AuthenticatorP5apply_2toy10CredentialQz_10Foundation10URLRequestVztF">apply(_:<wbr>to:<wbr>)</a>
    616. 

  616.                     </code>
    617. 

  617.                   </div>
    618. 

  618.                   <div class="height-container">
    619. 

  619.                     <div class="pointer-container"></div>
    620. 

  620.                     <section class="section">
    621. 

  621.                       <div class="pointer"></div>
    622. 

  622.                       <div class="abstract">
    623. 

  623.                         <p>Applies the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> to the <code>URLRequest</code>.</p>
    624. 

  624. 

  625. <p>In the case of OAuth2, the access token of the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> would be added to the <code>URLRequest</code> as a Bearer
    626. 

  626. token to the <code>Authorization</code> header.</p>
    627. 

  627. 

  628.                       </div>
    629. 

  629.                       <div class="declaration">
    630. 

  630.                         <h4>Declaration</h4>
    631. 

  631.                         <div class="language">
    632. 

  632.                           <p class="aside-title">Swift</p>
    633. 

  633.                           <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></span><span class="p">,</span> <span class="n">to</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">URLRequest</span><span class="p">)</span></code></pre>
    634. 

  634. 

  635.                         </div>
    636. 

  636.                       </div>
    637. 

  637.                       <div>
    638. 

  638.                         <h4>Parameters</h4>
    639. 

  639.                         <table class="graybox">
    640. 

  640.                           <tbody>
    641. 

  641.                             <tr>
    642. 

  642.                               <td>
    643. 

  643.                                 <code>
    644. 

  644.                                 <em>credential</em>
    645. 

  645.                                 </code>
    646. 

  646.                               </td>
    647. 

  647.                               <td>
    648. 

  648.                                 <div>
    649. 

  649.                                   <p>The <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>.</p>
    650. 

  650.                                 </div>
    651. 

  651.                               </td>
    652. 

  652.                             </tr>
    653. 

  653.                             <tr>
    654. 

  654.                               <td>
    655. 

  655.                                 <code>
    656. 

  656.                                 <em>urlRequest</em>
    657. 

  657.                                 </code>
    658. 

  658.                               </td>
    659. 

  659.                               <td>
    660. 

  660.                                 <div>
    661. 

  661.                                   <p>The <code>URLRequest</code>.</p>
    662. 

  662.                                 </div>
    663. 

  663.                               </td>
    664. 

  664.                             </tr>
    665. 

  665.                           </tbody>
    666. 

  666.                         </table>
    667. 

  667.                       </div>
    668. 

  668.                     </section>
    669. 

  669.                   </div>
    670. 

  670.                 </li>
    671. 

  671.                 <li class="item">
    672. 

  672.                   <div>
    673. 

  673.                     <code>
    674. 

  674.                     <a name="/s:9Alamofire13AuthenticatorP7refresh_3for10completiony10CredentialQz_AA7SessionCys6ResultOyAHs5Error_pGctF"></a>
    675. 

  675.                     <a name="//apple_ref/swift/Method/refresh(_:for:completion:)" class="dashAnchor"></a>
    676. 

  676.                     <a class="token" href="#/s:9Alamofire13AuthenticatorP7refresh_3for10completiony10CredentialQz_AA7SessionCys6ResultOyAHs5Error_pGctF">refresh(_:<wbr>for:<wbr>completion:<wbr>)</a>
    677. 

  677.                     </code>
    678. 

  678.                   </div>
    679. 

  679.                   <div class="height-container">
    680. 

  680.                     <div class="pointer-container"></div>
    681. 

  681.                     <section class="section">
    682. 

  682.                       <div class="pointer"></div>
    683. 

  683.                       <div class="abstract">
    684. 

  684.                         <p>Refreshes the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> and executes the <code>completion</code> closure with the <code>Result</code> once complete.</p>
    685. 

  685. 

  686. <p>Refresh can be called in one of two ways. It can be called before the <code><a href="../Classes/Request.html">Request</a></code> is actually executed due to
    687. 

  687. a <code>requiresRefresh</code> returning <code>true</code> during the adapt portion of the <code><a href="../Classes/Request.html">Request</a></code> creation process. It can also
    688. 

  688. be triggered by a failed <code><a href="../Classes/Request.html">Request</a></code> where the authentication server denied access due to an expired or
    689. 

  689. invalidated access token.</p>
    690. 

  690. 

  691. <p>In the case of OAuth2, this method would use the refresh token of the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> to generate a new
    692. 

  692. <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> using the authentication service. Once complete, the <code>completion</code> closure should be called with
    693. 

  693. the new <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>, or the error that occurred.</p>
    694. 

  694. 

  695. <p>In general, if the refresh call fails with certain status codes from the authentication server (commonly a 401),
    696. 

  696. the refresh token in the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> can no longer be used to generate a valid <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>. In these cases,
    697. 

  697. you will need to reauthenticate the user with their username / password.</p>
    698. 

  698. 

  699. <p>Please note, these are just general examples of common use cases. They are not meant to solve your specific
    700. 

  700. authentication server challenges. Please work with your authentication server team to ensure your
    701. 

  701. <code>Authenticator</code> logic matches their expectations.</p>
    702. 

  702. 

  703.                       </div>
    704. 

  704.                       <div class="declaration">
    705. 

  705.                         <h4>Declaration</h4>
    706. 

  706.                         <div class="language">
    707. 

  707.                           <p class="aside-title">Swift</p>
    708. 

  708.                           <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">refresh</span><span class="p">(</span><span class="n">_</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></span><span class="p">,</span> <span class="k">for</span> <span class="nv">session</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html">Session</a></span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Result</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
    709. 

  709. 

  710.                         </div>
    711. 

  711.                       </div>
    712. 

  712.                       <div>
    713. 

  713.                         <h4>Parameters</h4>
    714. 

  714.                         <table class="graybox">
    715. 

  715.                           <tbody>
    716. 

  716.                             <tr>
    717. 

  717.                               <td>
    718. 

  718.                                 <code>
    719. 

  719.                                 <em>credential</em>
    720. 

  720.                                 </code>
    721. 

  721.                               </td>
    722. 

  722.                               <td>
    723. 

  723.                                 <div>
    724. 

  724.                                   <p>The <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> to refresh.</p>
    725. 

  725.                                 </div>
    726. 

  726.                               </td>
    727. 

  727.                             </tr>
    728. 

  728.                             <tr>
    729. 

  729.                               <td>
    730. 

  730.                                 <code>
    731. 

  731.                                 <em>session</em>
    732. 

  732.                                 </code>
    733. 

  733.                               </td>
    734. 

  734.                               <td>
    735. 

  735.                                 <div>
    736. 

  736.                                   <p>The <code><a href="../Classes/Session.html">Session</a></code> requiring the refresh.</p>
    737. 

  737.                                 </div>
    738. 

  738.                               </td>
    739. 

  739.                             </tr>
    740. 

  740.                             <tr>
    741. 

  741.                               <td>
    742. 

  742.                                 <code>
    743. 

  743.                                 <em>completion</em>
    744. 

  744.                                 </code>
    745. 

  745.                               </td>
    746. 

  746.                               <td>
    747. 

  747.                                 <div>
    748. 

  748.                                   <p>The closure to be executed once the refresh is complete.</p>
    749. 

  749.                                 </div>
    750. 

  750.                               </td>
    751. 

  751.                             </tr>
    752. 

  752.                           </tbody>
    753. 

  753.                         </table>
    754. 

  754.                       </div>
    755. 

  755.                     </section>
    756. 

  756.                   </div>
    757. 

  757.                 </li>
    758. 

  758.                 <li class="item">
    759. 

  759.                   <div>
    760. 

  760.                     <code>
    761. 

  761.                     <a name="/s:9Alamofire13AuthenticatorP10didRequest_4with28failDueToAuthenticationErrorSb10Foundation10URLRequestV_So17NSHTTPURLResponseCs0J0_ptF"></a>
    762. 

  762.                     <a name="//apple_ref/swift/Method/didRequest(_:with:failDueToAuthenticationError:)" class="dashAnchor"></a>
    763. 

  763.                     <a class="token" href="#/s:9Alamofire13AuthenticatorP10didRequest_4with28failDueToAuthenticationErrorSb10Foundation10URLRequestV_So17NSHTTPURLResponseCs0J0_ptF">didRequest(_:<wbr>with:<wbr>failDueToAuthenticationError:<wbr>)</a>
    764. 

  764.                     </code>
    765. 

  765.                   </div>
    766. 

  766.                   <div class="height-container">
    767. 

  767.                     <div class="pointer-container"></div>
    768. 

  768.                     <section class="section">
    769. 

  769.                       <div class="pointer"></div>
    770. 

  770.                       <div class="abstract">
    771. 

  771.                         <p>Determines whether the <code>URLRequest</code> failed due to an authentication error based on the <code>HTTPURLResponse</code>.</p>
    772. 

  772. 

  773. <p>If the authentication server <strong>CANNOT</strong> invalidate credentials after they are issued, then simply return <code>false</code>
    774. 

  774. for this method. If the authentication server <strong>CAN</strong> invalidate credentials due to security breaches, then you
    775. 

  775. will need to work with your authentication server team to understand how to identify when this occurs.</p>
    776. 

  776. 

  777. <p>In the case of OAuth2, where an authentication server can invalidate credentials, you will need to inspect the
    778. 

  778. <code>HTTPURLResponse</code> or possibly the <code>Error</code> for when this occurs. This is commonly handled by the authentication
    779. 

  779. server returning a 401 status code and some additional header to indicate an OAuth2 failure occurred.</p>
    780. 

  780. 

  781. <p>It is very important to understand how your authentication server works to be able to implement this correctly.
    782. 

  782. For example, if your authentication server returns a 401 when an OAuth2 error occurs, and your downstream
    783. 

  783. service also returns a 401 when you are not authorized to perform that operation, how do you know which layer
    784. 

  784. of the backend returned you a 401? You do not want to trigger a refresh unless you know your authentication
    785. 

  785. server is actually the layer rejecting the request. Again, work with your authentication server team to understand
    786. 

  786. how to identify an OAuth2 401 error vs. a downstream 401 error to avoid endless refresh loops.</p>
    787. 

  787. 

  788.                       </div>
    789. 

  789.                       <div class="declaration">
    790. 

  790.                         <h4>Declaration</h4>
    791. 

  791.                         <div class="language">
    792. 

  792.                           <p class="aside-title">Swift</p>
    793. 

  793.                           <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">didRequest</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">,</span> <span class="n">with</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span> <span class="n">failDueToAuthenticationError</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
    794. 

  794. 

  795.                         </div>
    796. 

  796.                       </div>
    797. 

  797.                       <div>
    798. 

  798.                         <h4>Parameters</h4>
    799. 

  799.                         <table class="graybox">
    800. 

  800.                           <tbody>
    801. 

  801.                             <tr>
    802. 

  802.                               <td>
    803. 

  803.                                 <code>
    804. 

  804.                                 <em>urlRequest</em>
    805. 

  805.                                 </code>
    806. 

  806.                               </td>
    807. 

  807.                               <td>
    808. 

  808.                                 <div>
    809. 

  809.                                   <p>The <code>URLRequest</code>.</p>
    810. 

  810.                                 </div>
    811. 

  811.                               </td>
    812. 

  812.                             </tr>
    813. 

  813.                             <tr>
    814. 

  814.                               <td>
    815. 

  815.                                 <code>
    816. 

  816.                                 <em>response</em>
    817. 

  817.                                 </code>
    818. 

  818.                               </td>
    819. 

  819.                               <td>
    820. 

  820.                                 <div>
    821. 

  821.                                   <p>The <code>HTTPURLResponse</code>.</p>
    822. 

  822.                                 </div>
    823. 

  823.                               </td>
    824. 

  824.                             </tr>
    825. 

  825.                             <tr>
    826. 

  826.                               <td>
    827. 

  827.                                 <code>
    828. 

  828.                                 <em>error</em>
    829. 

  829.                                 </code>
    830. 

  830.                               </td>
    831. 

  831.                               <td>
    832. 

  832.                                 <div>
    833. 

  833.                                   <p>The <code>Error</code>.</p>
    834. 

  834.                                 </div>
    835. 

  835.                               </td>
    836. 

  836.                             </tr>
    837. 

  837.                           </tbody>
    838. 

  838.                         </table>
    839. 

  839.                       </div>
    840. 

  840.                       <div>
    841. 

  841.                         <h4>Return Value</h4>
    842. 

  842.                         <p><code>true</code> if the <code>URLRequest</code> failed due to an authentication error, <code>false</code> otherwise.</p>
    843. 

  843.                       </div>
    844. 

  844.                     </section>
    845. 

  845.                   </div>
    846. 

  846.                 </li>
    847. 

  847.                 <li class="item">
    848. 

  848.                   <div>
    849. 

  849.                     <code>
    850. 

  850.                     <a name="/s:9Alamofire13AuthenticatorP9isRequest_17authenticatedWithSb10Foundation10URLRequestV_10CredentialQztF"></a>
    851. 

  851.                     <a name="//apple_ref/swift/Method/isRequest(_:authenticatedWith:)" class="dashAnchor"></a>
    852. 

  852.                     <a class="token" href="#/s:9Alamofire13AuthenticatorP9isRequest_17authenticatedWithSb10Foundation10URLRequestV_10CredentialQztF">isRequest(_:<wbr>authenticatedWith:<wbr>)</a>
    853. 

  853.                     </code>
    854. 

  854.                   </div>
    855. 

  855.                   <div class="height-container">
    856. 

  856.                     <div class="pointer-container"></div>
    857. 

  857.                     <section class="section">
    858. 

  858.                       <div class="pointer"></div>
    859. 

  859.                       <div class="abstract">
    860. 

  860.                         <p>Determines whether the <code>URLRequest</code> is authenticated with the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>.</p>
    861. 

  861. 

  862. <p>If the authentication server <strong>CANNOT</strong> invalidate credentials after they are issued, then simply return <code>true</code>
    863. 

  863. for this method. If the authentication server <strong>CAN</strong> invalidate credentials due to security breaches, then
    864. 

  864. read on.</p>
    865. 

  865. 

  866. <p>When an authentication server can invalidate credentials, it means that you may have a non-expired credential
    867. 

  867. that appears to be valid, but will be rejected by the authentication server when used. Generally when this
    868. 

  868. happens, a number of requests are all sent when the application is foregrounded, and all of them will be
    869. 

  869. rejected by the authentication server in the order they are received. The first failed request will trigger a
    870. 

  870. refresh internally, which will update the credential, and then retry all the queued requests with the new
    871. 

  871. credential. However, it is possible that some of the original requests will not return from the authentication
    872. 

  872. server until the refresh has completed. This is where this method comes in.</p>
    873. 

  873. 

  874. <p>When the authentication server rejects a credential, we need to check to make sure we haven&rsquo;t refreshed the
    875. 

  875. credential while the request was in flight. If it has already refreshed, then we don&rsquo;t need to trigger an
    876. 

  876. additional refresh. If it hasn&rsquo;t refreshed, then we need to refresh.</p>
    877. 

  877. 

  878. <p>Now that it is understood how the result of this method is used in the refresh lifecycle, let&rsquo;s walk through how
    879. 

  879. to implement it. You should return <code>true</code> in this method if the <code>URLRequest</code> is authenticated in a way that
    880. 

  880. matches the values in the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>. In the case of OAuth2, this would mean that the Bearer token in the
    881. 

  881. <code>Authorization</code> header of the <code>URLRequest</code> matches the access token in the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>. If it matches, then we
    882. 

  882. know the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code> was used to authenticate the <code>URLRequest</code> and should return <code>true</code>. If the Bearer token
    883. 

  883. did not match the access token, then you should return <code>false</code>.</p>
    884. 

  884. 

  885.                       </div>
    886. 

  886.                       <div class="declaration">
    887. 

  887.                         <h4>Declaration</h4>
    888. 

  888.                         <div class="language">
    889. 

  889.                           <p class="aside-title">Swift</p>
    890. 

  890.                           <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">isRequest</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">,</span> <span class="n">authenticatedWith</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
    891. 

  891. 

  892.                         </div>
    893. 

  893.                       </div>
    894. 

  894.                       <div>
    895. 

  895.                         <h4>Parameters</h4>
    896. 

  896.                         <table class="graybox">
    897. 

  897.                           <tbody>
    898. 

  898.                             <tr>
    899. 

  899.                               <td>
    900. 

  900.                                 <code>
    901. 

  901.                                 <em>urlRequest</em>
    902. 

  902.                                 </code>
    903. 

  903.                               </td>
    904. 

  904.                               <td>
    905. 

  905.                                 <div>
    906. 

  906.                                   <p>The <code>URLRequest</code>.</p>
    907. 

  907.                                 </div>
    908. 

  908.                               </td>
    909. 

  909.                             </tr>
    910. 

  910.                             <tr>
    911. 

  911.                               <td>
    912. 

  912.                                 <code>
    913. 

  913.                                 <em>credential</em>
    914. 

  914.                                 </code>
    915. 

  915.                               </td>
    916. 

  916.                               <td>
    917. 

  917.                                 <div>
    918. 

  918.                                   <p>The <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>.</p>
    919. 

  919.                                 </div>
    920. 

  920.                               </td>
    921. 

  921.                             </tr>
    922. 

  922.                           </tbody>
    923. 

  923.                         </table>
    924. 

  924.                       </div>
    925. 

  925.                       <div>
    926. 

  926.                         <h4>Return Value</h4>
    927. 

  927.                         <p><code>true</code> if the <code>URLRequest</code> is authenticated with the <code><a href="../Protocols/Authenticator.html#/s:9Alamofire13AuthenticatorP10CredentialQa">Credential</a></code>, <code>false</code> otherwise.</p>
    928. 

  928.                       </div>
    929. 

  929.                     </section>
    930. 

  930.                   </div>
    931. 

  931.                 </li>
    932. 

  932.               </ul>
    933. 

  933.             </div>
    934. 

  934.           </div>
    935. 

  935.         </section>
    936. 

  936. 

  937.       </article>
    938. 

  938.     </div>
    939. 

  939.     <section class="footer">
    940. 

  940.       <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>
    941. 

  941.       <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>
    942. 

  942.     </section>
    943. 

  943.   </body>
    944. 

  944. </html>
    945.