516 lines
28 KiB
HTML
516 lines
28 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>Enumerations Reference</title>
|
||
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
|
||
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
|
||
<meta charset="utf-8">
|
||
<script src="js/jquery.min.js" defer></script>
|
||
<script src="js/jazzy.js" defer></script>
|
||
|
||
<script src="js/lunr.min.js" defer></script>
|
||
<script src="js/typeahead.jquery.js" defer></script>
|
||
<script src="js/jazzy.search.js" defer></script>
|
||
</head>
|
||
<body>
|
||
|
||
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
|
||
|
||
<a title="Enumerations Reference"></a>
|
||
|
||
<header class="header">
|
||
<p class="header-col header-col--primary">
|
||
<a class="header-link" href="index.html">
|
||
Alamofire Docs
|
||
</a>
|
||
(86% documented)
|
||
</p>
|
||
|
||
<p class="header-col--secondary">
|
||
<form role="search" action="search.json">
|
||
<input type="text" placeholder="Search documentation" data-typeahead>
|
||
</form>
|
||
</p>
|
||
|
||
<p class="header-col header-col--secondary">
|
||
<a class="header-link" href="https://github.com/Alamofire/Alamofire">
|
||
<img class="header-icon" src="img/gh.png"/>
|
||
View on GitHub
|
||
</a>
|
||
</p>
|
||
|
||
<p class="header-col header-col--secondary">
|
||
<a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
|
||
<img class="header-icon" src="img/dash.png"/>
|
||
Install in Dash
|
||
</a>
|
||
</p>
|
||
</header>
|
||
|
||
<p class="breadcrumbs">
|
||
<a class="breadcrumb" href="index.html">Alamofire Reference</a>
|
||
<img class="carat" src="img/carat.png" />
|
||
Enumerations Reference
|
||
</p>
|
||
|
||
<div class="content-wrapper">
|
||
<nav class="navigation">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Classes.html">Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/Request.html">Request</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/Request/ValidationResult.html">– ValidationResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/SessionManager.html">SessionManager</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/TaskDelegate.html">TaskDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/HTTPMethod.html">HTTPMethod</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/Result.html">Result</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Notification/Name.html">– Name</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Notification/Key.html">– Key</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Functions.html">Functions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Structs.html">Structures</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DataResponseSerializer.html">DataResponseSerializer</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DefaultDataResponse.html">DefaultDataResponse</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/PropertyListEncoding.html">PropertyListEncoding</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Timeline.html">Timeline</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
|
||
<section class="section">
|
||
<div class="section-content">
|
||
<h1>Enumerations</h1>
|
||
<p>The following enumerations are available globally.</p>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<section class="section">
|
||
<div class="section-content">
|
||
<div class="task-group">
|
||
<ul class="item-container">
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:9Alamofire7AFErrorO"></a>
|
||
<a name="//apple_ref/swift/Enum/AFError" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:9Alamofire7AFErrorO">AFError</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p><code>AFError</code> is the error type returned by Alamofire. It encompasses a few different types of errors, each with
|
||
their own associated reasons.</p>
|
||
|
||
<ul>
|
||
<li>invalidURL: Returned when a <code><a href="Protocols/URLConvertible.html">URLConvertible</a></code> type fails to create a valid <code>URL</code>.</li>
|
||
<li>parameterEncodingFailed: Returned when a parameter encoding object throws an error during the encoding process.</li>
|
||
<li>multipartEncodingFailed: Returned when some step in the multipart encoding process fails.</li>
|
||
<li>responseValidationFailed: Returned when a <code>validate()</code> call fails.</li>
|
||
<li>responseSerializationFailed: Returned when a response serializer encounters an error in the serialization process.</li>
|
||
</ul>
|
||
|
||
<a href="Enums/AFError.html" class="slightly-smaller">See more</a>
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AFError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="task-group">
|
||
<ul class="item-container">
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:9Alamofire10HTTPMethodO"></a>
|
||
<a name="//apple_ref/swift/Enum/HTTPMethod" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:9Alamofire10HTTPMethodO">HTTPMethod</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>HTTP method definitions.</p>
|
||
|
||
<p>See <a href="https://tools.ietf.org/html/rfc7231#section-4.3">https://tools.ietf.org/html/rfc7231#section-4.3</a></p>
|
||
|
||
<a href="Enums/HTTPMethod.html" class="slightly-smaller">See more</a>
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">HTTPMethod</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="task-group">
|
||
<ul class="item-container">
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:9Alamofire6ResultO"></a>
|
||
<a name="//apple_ref/swift/Enum/Result" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:9Alamofire6ResultO">Result</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Used to represent whether a request was successful or encountered an error.</p>
|
||
|
||
<ul>
|
||
<li><p>success: The request and all post processing operations were successful resulting in the serialization of the
|
||
provided associated value.</p></li>
|
||
<li><p>failure: The request encountered an error resulting in a failure. The associated values are the original data
|
||
provided by the server as well as the error that caused the failure.</p></li>
|
||
</ul>
|
||
|
||
<a href="Enums/Result.html" class="slightly-smaller">See more</a>
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Result</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="task-group">
|
||
<div class="task-name-container">
|
||
<a name="/ServerTrustPolicy"></a>
|
||
<a name="//apple_ref/swift/Section/ServerTrustPolicy" class="dashAnchor"></a>
|
||
<a href="#/ServerTrustPolicy">
|
||
<h3 class="section-name">ServerTrustPolicy</h3>
|
||
</a>
|
||
</div>
|
||
<ul class="item-container">
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:9Alamofire17ServerTrustPolicyO"></a>
|
||
<a name="//apple_ref/swift/Enum/ServerTrustPolicy" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:9Alamofire17ServerTrustPolicyO">ServerTrustPolicy</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The <code>ServerTrustPolicy</code> evaluates the server trust generally provided by an <code>NSURLAuthenticationChallenge</code> when
|
||
connecting to a server over a secure HTTPS connection. The policy configuration then evaluates the server trust
|
||
with a given set of criteria to determine whether the server trust is valid and the connection should be made.</p>
|
||
|
||
<p>Using pinned certificates or public keys for evaluation helps prevent man-in-the-middle (MITM) attacks and other
|
||
vulnerabilities. Applications dealing with sensitive customer data or financial information are strongly encouraged
|
||
to route all communication over an HTTPS connection with pinning enabled.</p>
|
||
|
||
<ul>
|
||
<li><p>performDefaultEvaluation: Uses the default server trust evaluation while allowing you to control whether to
|
||
validate the host provided by the challenge. Applications are encouraged to always
|
||
validate the host in production environments to guarantee the validity of the server’s
|
||
certificate chain.</p></li>
|
||
<li><p>performRevokedEvaluation: Uses the default and revoked server trust evaluations allowing you to control whether to
|
||
validate the host provided by the challenge as well as specify the revocation flags for
|
||
testing for revoked certificates. Apple platforms did not start testing for revoked
|
||
certificates automatically until iOS 10.1, macOS 10.12 and tvOS 10.1 which is
|
||
demonstrated in our TLS tests. Applications are encouraged to always validate the host
|
||
in production environments to guarantee the validity of the server’s certificate chain.</p></li>
|
||
<li><p>pinCertificates: Uses the pinned certificates to validate the server trust. The server trust is
|
||
considered valid if one of the pinned certificates match one of the server certificates.
|
||
By validating both the certificate chain and host, certificate pinning provides a very
|
||
secure form of server trust validation mitigating most, if not all, MITM attacks.
|
||
Applications are encouraged to always validate the host and require a valid certificate
|
||
chain in production environments.</p></li>
|
||
<li><p>pinPublicKeys: Uses the pinned public keys to validate the server trust. The server trust is considered
|
||
valid if one of the pinned public keys match one of the server certificate public keys.
|
||
By validating both the certificate chain and host, public key pinning provides a very
|
||
secure form of server trust validation mitigating most, if not all, MITM attacks.
|
||
Applications are encouraged to always validate the host and require a valid certificate
|
||
chain in production environments.</p></li>
|
||
<li><p>disableEvaluation: Disables all evaluation which in turn will always consider any server trust as valid.</p></li>
|
||
<li><p>customEvaluation: Uses the associated closure to evaluate the validity of the server trust.</p></li>
|
||
</ul>
|
||
|
||
<a href="Enums/ServerTrustPolicy.html" class="slightly-smaller">See more</a>
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ServerTrustPolicy</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<section class="footer">
|
||
<p>© 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-01-15)</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</body>
|
||
</div>
|
||
</html>
|