| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>URLEncoding Structure 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/Struct/URLEncoding" class="dashAnchor"></a>
- <a title="URLEncoding Structure Reference"></a>
- <header class="header">
- <p class="header-col header-col--primary">
- <a class="header-link" href="../index.html">
- Alamofire 5.10.2 Docs
- </a>
- (96% documented)
- </p>
-
- <div class="header-col--secondary">
- <form role="search" action="../search.json">
- <input type="text" placeholder="Search documentation" data-typeahead>
- </form>
- </div>
-
- <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" alt="GitHub"/>
- View on GitHub
- </a>
- </p>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
- <img class="header-icon" src="../img/dash.png" alt="Dash"/>
- Install in Dash
- </a>
- </p>
- </header>
- <p class="breadcrumbs">
- <a class="breadcrumb" href="../index.html">Alamofire</a>
- <img class="carat" src="../img/carat.png" alt=""/>
- <a class="breadcrumb" href="../Structs.html">Structures</a>
- <img class="carat" src="../img/carat.png" alt=""/>
- URLEncoding Structure 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/Adapter.html">Adapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
- </li>
- <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/DataResponseSerializer.html">DataResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</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/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</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/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</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/State.html">– State</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Session.html">Session</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/StringResponseSerializer.html">StringResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</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/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</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/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</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/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</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.html#/s:Sa">Array</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
- </li>
- <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.html#/c:@T@OSStatus">OSStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/Protected">Protected</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</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>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</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/AlamofireExtended.html">AlamofireExtended</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
- </li>
- <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/DataStreamSerializer.html">DataStreamSerializer</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/EmptyResponse.html">EmptyResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</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/RedirectHandler.html">RedirectHandler</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/RequestDelegate.html">RequestDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</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/ResponseSerializer.html">ResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</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>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</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/AlamofireExtension.html">AlamofireExtension</a>
- </li>
- <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/DataResponsePublisher.html">DataResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</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/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</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/JSONEncoding/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</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>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</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:9Alamofire14AFDataResponsea">AFDataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</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:9Alamofire12RetryHandlera">RetryHandler</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section class="section">
- <div class="section-content top-matter">
- <h1>URLEncoding</h1>
- <div class="declaration">
- <div class="language">
-
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">URLEncoding</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
- </div>
- </div>
- <p>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
- body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
- the HTTP body depends on the destination of the encoding.</p>
- <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
- <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
- <p>There is no published specification for how to encode collection types. By default the convention of appending
- <code>[]</code> to the key for array values (<code>foo[]=1&foo[]=2</code>), and appending the key surrounded by square brackets for
- nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
- square brackets appended to array keys.</p>
- <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
- <code>true</code> as 1 and <code>false</code> as 0.</p>
- </div>
- </section>
- <section class="section">
- <div class="section-content">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Helper%20Types"></a>
- <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Helper%20Types"></a>
- <h3 class="section-name"><span>Helper Types</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV11DestinationO"></a>
- <a name="//apple_ref/swift/Enum/Destination" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV11DestinationO">Destination</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Defines whether the url-encoded query string is applied to the existing query string or HTTP body of the
- resulting URL request.</p>
- <a href="../Structs/URLEncoding/Destination.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">Destination</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV13ArrayEncodingO"></a>
- <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV13ArrayEncodingO">ArrayEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Configures how <code>Array</code> parameters are encoded.</p>
- <a href="../Structs/URLEncoding/ArrayEncoding.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">ArrayEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV12BoolEncodingO"></a>
- <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV12BoolEncodingO">BoolEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Configures how <code>Bool</code> parameters are encoded.</p>
- <a href="../Structs/URLEncoding/BoolEncoding.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">BoolEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Properties"></a>
- <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Properties"></a>
- <h3 class="section-name"><span>Properties</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV7defaultACvpZ"></a>
- <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV7defaultACvpZ">default</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns a default <code>URLEncoding</code> instance with a <code>.methodDependent</code> destination.</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">var</span> <span class="p">`</span><span class="nv">default</span><span class="p">`:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV11queryStringACvpZ"></a>
- <a name="//apple_ref/swift/Variable/queryString" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV11queryStringACvpZ">queryString</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns a <code>URLEncoding</code> instance with a <code>.queryString</code> destination.</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="k">var</span> <span class="nv">queryString</span><span class="p">:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV8httpBodyACvpZ"></a>
- <a name="//apple_ref/swift/Variable/httpBody" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV8httpBodyACvpZ">httpBody</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns a <code>URLEncoding</code> instance with an <code>.httpBody</code> destination.</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="k">var</span> <span class="nv">httpBody</span><span class="p">:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp"></a>
- <a name="//apple_ref/swift/Property/destination" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp">destination</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The destination defining where the encoded query string is to be applied to the URL 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">public</span> <span class="k">let</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/Destination.html">Destination</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp"></a>
- <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp">arrayEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The encoding to use for <code>Array</code> parameters.</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="k">let</span> <span class="nv">arrayEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp"></a>
- <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp">boolEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The encoding to use for <code>Bool</code> parameters.</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="k">let</span> <span class="nv">boolEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Initialization"></a>
- <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Initialization"></a>
- <h3 class="section-name"><span>Initialization</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc"></a>
- <a name="//apple_ref/swift/Method/init(destination:arrayEncoding:boolEncoding:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc">init(destination:<wbr>arrayEncoding:<wbr>boolEncoding:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates an instance using the specified parameters.</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="nf">init</span><span class="p">(</span><span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/Destination.html">Destination</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">methodDependent</span><span class="p">,</span>
- <span class="nv">arrayEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">brackets</span><span class="p">,</span>
- <span class="nv">boolEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">numeric</span><span class="p">)</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/URLEncoding/Destination.html">Destination</a></code> defining where the encoded query string will be applied. <code>.methodDependent</code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>arrayEncoding</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>boolEncoding</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Encoding"></a>
- <a name="//apple_ref/swift/Section/Encoding" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Encoding"></a>
- <h3 class="section-name"><span>Encoding</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSs8Sendable_pGSgtKF"></a>
- <a name="//apple_ref/swift/Method/encode(_:with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSs8Sendable_pGSgtKF">encode(_:<wbr>with:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </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">encode</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kd">any</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="n">with</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">URLRequest</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF"></a>
- <a name="//apple_ref/swift/Method/queryComponents(fromKey:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF">queryComponents(fromKey:<wbr>value:<wbr>)</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 percent-escaped, URL encoded query string components from the given key-value pair recursively.</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">queryComponents</span><span class="p">(</span><span class="n">fromKey</span> <span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Any</span><span class="p">)</span> <span class="o">-></span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>key</em>
- </code>
- </td>
- <td>
- <div>
- <p>Key of the query component.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>Value of the query component.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The percent-escaped, URL encoded query string components.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV6escapeyS2SF"></a>
- <a name="//apple_ref/swift/Method/escape(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV6escapeyS2SF">escape(_:<wbr>)</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 percent-escaped string following RFC 3986 for a query string key or value.</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">escape</span><span class="p">(</span><span class="n">_</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>string</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>String</code> to be percent-escaped.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The percent-escaped <code>String</code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </div>
- </section>
- </article>
- </div>
- <section class="footer">
- <p>© 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-11-24)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
- </section>
- </body>
- </html>
|