react-native-c8osdk

<!DOCTYPE html> <html lang="en"> <head> <title>DataRequest Class 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/Class/DataRequest" class="dashAnchor"></a> <a title="DataRequest Class 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" /> DataRequest Class 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:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">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>DataRequest</h1> <div class="declaration"> <div class="language"> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">DataRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre> </div> </div> <p>Specific type of <code><a href="../Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDataTask</code>.</p> </div> </section> <section class="section"> <div class="section-content"> <div class="task-group"> <div class="task-name-container"> <a name="/Properties"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a href="#/Properties"> <h3 class="section-name">Properties</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC7request10Foundation10URLRequestVSgvp"></a> <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC7request10Foundation10URLRequestVSgvp">request</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>The request sent or to be sent to the server.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC8progressSo8ProgressCvp"></a> <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC8progressSo8ProgressCvp">progress</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>The progress of fetching the response data from the server for the request.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre> </div> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <div class="task-name-container"> <a name="/Stream"></a> <a name="//apple_ref/swift/Section/Stream" class="dashAnchor"></a> <a href="#/Stream"> <h3 class="section-name">Stream</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC6streamACXDy10Foundation0B0VcSg7closure_tF"></a> <a name="//apple_ref/swift/Method/stream(closure:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC6streamACXDy10Foundation0B0VcSg7closure_tF">stream(closure:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Sets a closure to be called periodically during the lifecycle of the request as data is read from the server.</p> <p>This closure returns the bytes most recently received from the server, not including data from previous calls. If this closure is set, data will only be available within this closure, and will not be saved elsewhere. It is also important to note that the server data in any <code>Response</code> object will be <code>nil</code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">stream</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Data</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>closure</em> </code> </td> <td> <div> <p>The code to be executed periodically during the lifecycle of the request.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <div class="task-name-container"> <a name="/Progress"></a> <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a> <a href="#/Progress"> <h3 class="section-name">Progress</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF"></a> <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF">downloadProgress(queue:closure:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Sets a closure to be called periodically during the lifecycle of the <code><a href="../Classes/Request.html">Request</a></code> as data is read from the server.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">downloadProgress</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">ProgressHandler</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>queue</em> </code> </td> <td> <div> <p>The dispatch queue to execute the closure on.</p> </div> </td> </tr> <tr> <td> <code> <em>closure</em> </code> </td> <td> <div> <p>The code to be executed periodically as data is read from the server.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF"></a> <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF">response(queue:completionHandler:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Adds a handler to be called once the request has finished.</p> </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">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>queue</em> </code> </td> <td> <div> <p>The queue on which the completion handler is dispatched.</p> </div> </td> </tr> <tr> <td> <code> <em>completionHandler</em> </code> </td> <td> <div> <p>The code to be executed once the request has finished.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF"></a> <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Adds a handler to be called once the request has finished.</p> </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">func</span> <span class="n">response</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a></span><span class="o">></span><span class="p">(</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DataResponse.html">DataResponse</a></span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>queue</em> </code> </td> <td> <div> <p>The queue on which the completion handler is dispatched.</p> </div> </td> </tr> <tr> <td> <code> <em>responseSerializer</em> </code> </td> <td> <div> <p>The response serializer responsible for serializing the request, response, and data.</p> </div> </td> </tr> <tr> <td> <code> <em>completionHandler</em> </code> </td> <td> <div> <p>The code to be executed once the request has finished.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC22dataResponseSerializerAA0beF0Vy10Foundation0B0VGyFZ"></a> <a name="//apple_ref/swift/Method/dataResponseSerializer()" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC22dataResponseSerializerAA0beF0Vy10Foundation0B0VGyFZ">dataResponseSerializer()</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a response serializer that returns the associated data as-is.</p> </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">static</span> <span class="kd">func</span> <span class="nf">dataResponseSerializer</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o"><</span><span class="kt">Data</span><span class="o">></span></code></pre> </div> </div> <div> <h4>Return Value</h4> <p>A data response serializer.</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC08responseB0ACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0B0VGc17completionHandlertF"></a> <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC08responseB0ACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0B0VGc17completionHandlertF">responseData(queue:completionHandler:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Adds a handler to be called once the request has finished.</p> </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">func</span> <span class="nf">responseData</span><span class="p">(</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DataResponse.html">DataResponse</a></span><span class="o"><</span><span class="kt">Data</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>completionHandler</em> </code> </td> <td> <div> <p>The code to be executed once the request has finished.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ"></a> <a name="//apple_ref/swift/Method/stringResponseSerializer(encoding:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ">stringResponseSerializer(encoding:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a response serializer that returns a result string type initialized from the response data with the specified string encoding.</p> </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">static</span> <span class="kd">func</span> <span class="nf">stringResponseSerializer</span><span class="p">(</span><span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>encoding</em> </code> </td> <td> <div> <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server response, falling back to the default HTTP default character set, ISO-8859-1.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>A string response serializer.</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF"></a> <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire11DataRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF">responseString(queue:encoding:completionHandler:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Adds a handler to be called once the request has finished.</p> </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">func</span> <span class="nf">responseString</span><span class="p">(</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DataResponse.html">DataResponse</a></span><span class="o"><</span><span class="kt">String</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>encoding</em> </code> </td> <td> <div> <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server response, falling back to the default HTTP default character set, ISO-8859-1.</p> </div> </td> </tr> <tr> <td> <code> <em>completionHandler</em> </code> </td> <td> <div> <p>A closure to be executed once the request has finished.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The request.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire11DataRequestC22jsonResponseSerializerAA0beF0VyypGSo17JSONSerializationC14ReadingOptionsV7options_tFZ"></a>