blob: 0405ff5fa1809119c5b6a8d4e6fe9f0868737a89 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<title>UsergridRequest 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>
</head>
<body>
<a name="//apple_ref/swift/Class/UsergridRequest" class="dashAnchor"></a>
<a title="UsergridRequest Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
UsergridRequest Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/Usergrid.html">Usergrid</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridAsset.html">UsergridAsset</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridAuth.html">UsergridAuth</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridClient.html">UsergridClient</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridDevice.html">UsergridDevice</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridEntity.html">UsergridEntity</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridQuery.html">UsergridQuery</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridRequest.html">UsergridRequest</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridResponse.html">UsergridResponse</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridResponseError.html">UsergridResponseError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridUser.html">UsergridUser</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridDirection.html">UsergridDirection</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/NSDate.html">NSDate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>UsergridRequest</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Instance%20Properties"></a>
<a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a>
<a href="#/Instance%20Properties">
<h3 class="section-name">Instance Properties</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod"></a>
<a name="//apple_ref/swift/Property/method" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod">method</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The HTTP method.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">method</span><span class="p">:</span> <span class="kt">UsergridHttpMethod</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest7baseUrlSS"></a>
<a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7baseUrlSS">baseUrl</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The base URL.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">baseUrl</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__"></a>
<a name="//apple_ref/swift/Property/paths" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__">paths</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The paths to append to the base URL.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">paths</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_"></a>
<a name="//apple_ref/swift/Property/query" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_">query</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The query to append to the URL.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_"></a>
<a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_">auth</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The auth that will be used.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__"></a>
<a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__">headers</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The headers to add to the request.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">headers</span><span class="p">:</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>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__"></a>
<a name="//apple_ref/swift/Property/jsonBody" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__">jsonBody</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The JSON body that will be set on the request. Can be either a valid JSON object or NSData.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">jsonBody</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__"></a>
<a name="//apple_ref/swift/Property/queryParams" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__">queryParams</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The query params that will be set on the request.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">queryParams</span><span class="p">:</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>
</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>
<a href="#/Initialization">
<h3 class="section-name">Initialization</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_"></a>
<a name="//apple_ref/swift/Method/init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_">init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The designated initializer for <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span><span class="kt">UsergridHttpMethod</span><span class="p">,</span>
<span class="nv">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span>
<span class="nv">paths</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">headers</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">jsonBody</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">queryParams</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>method</em>
</code>
</td>
<td>
<div>
<p>The HTTP method.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>baseUrl</em>
</code>
</td>
<td>
<div>
<p>The base URL.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>paths</em>
</code>
</td>
<td>
<div>
<p>The optional paths to append to the base URL.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>query</em>
</code>
</td>
<td>
<div>
<p>The optional query to append to the URL.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>auth</em>
</code>
</td>
<td>
<div>
<p>The optional <code>UsergridAuth</code> that will be used in the Authorization header.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>headers</em>
</code>
</td>
<td>
<div>
<p>The optional headers.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>jsonBody</em>
</code>
</td>
<td>
<div>
<p>The optional JSON body. Can be either a valid JSON object or NSData.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>queryParams</em>
</code>
</td>
<td>
<div>
<p>The optional query params to be appended to the request url.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new instance of <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code>.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Instance%20Methods"></a>
<a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
<a href="#/Instance%20Methods">
<h3 class="section-name">Instance Methods</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest"></a>
<a name="//apple_ref/swift/Method/buildNSURLRequest()" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest">buildNSURLRequest()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constructs a <code>NSURLRequest</code> object with this objects instance properties.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">buildNSURLRequest</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">NSURLRequest</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>An initialized and configured <code>NSURLRequest</code> object.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>