Google Git
Sign in
apache / usergrid / 1684a64e408212be47a653e8d64ded06573a3312 / . / sdks / swift / docs / Classes / UsergridEntity.html
blob: 7d937fd9219b69c660f5ef45c47ebe1815719125 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<title>UsergridEntity 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/UsergridEntity" class="dashAnchor"></a>
<a title="UsergridEntity Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">UsergridSDK Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">UsergridSDK Reference</a>
<img id="carat" src="../img/carat.png" />
UsergridEntity 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/UsergridAuthFallback.html">UsergridAuthFallback</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="../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>UsergridEntity</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
</div>
</div>
<p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:sC11UsergridSDK14UsergridEntity9subscriptFSSGSqPSs9AnyObject__"></a>
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:sC11UsergridSDK14UsergridEntity9subscriptFSSGSqPSs9AnyObject__">subscript(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Subscript for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> class.</p>
<ul>
<li>Example usage:
<code>
let propertyValue = usergridEntity[&quot;propertyName&quot;]
usergridEntity[&quot;propertyName&quot;] = propertyValue
</code></li>
</ul>
</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">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK14UsergridEntity5assetGSqCS_13UsergridAsset_"></a>
<a name="//apple_ref/swift/Property/asset" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity5assetGSqCS_13UsergridAsset_">asset</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> that contains the asset data.</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">var</span> <span class="nv">asset</span><span class="p">:</span> <span class="kt">UsergridAsset</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_"></a>
<a name="//apple_ref/swift/Property/fileMetaData" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_">fileMetaData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a></code> of this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">private(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">fileMetaData</span> <span class="p">:</span> <span class="kt">UsergridFileMetaData</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity4typeSS"></a>
<a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">UsergridEntityProperties.EntityType</a></code>.</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">var</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">EntityType</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity4uuidGSqSS_"></a>
<a name="//apple_ref/swift/Property/uuid" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4uuidGSqSS_">uuid</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UsergridEntityProperties.UUID</a></code>.</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">var</span> <span class="nv">uuid</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">UUID</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity4nameGSqSS_"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4nameGSqSS_">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">UsergridEntityProperties.Name</a></code>.</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">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Name</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_"></a>
<a name="//apple_ref/swift/Property/created" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_">created</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">UsergridEntityProperties.Created</a></code>.</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">var</span> <span class="nv">created</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Created</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_"></a>
<a name="//apple_ref/swift/Property/modified" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_">modified</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">UsergridEntityProperties.Modified</a></code>.</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">var</span> <span class="nv">modified</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Modified</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_"></a>
<a name="//apple_ref/swift/Property/location" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_">location</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">UsergridEntityProperties.Location</a></code>.</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">var</span> <span class="nv">location</span><span class="p">:</span> <span class="kt">CLLocation</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_"></a>
<a name="//apple_ref/swift/Property/uuidOrName" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_">uuidOrName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method to get the UUID or name of the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">var</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">name</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity6isUserSb"></a>
<a name="//apple_ref/swift/Property/isUser" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity6isUserSb">isUser</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tells you if this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> has a type of <code>user</code>.</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">var</span> <span class="nv">isUser</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span> <span class="k">is</span> <span class="kt">UsergridUser</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="kt">UsergridUser</span><span class="o">.</span><span class="kt">USER_ENTITY_TYPE</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity8hasAssetSb"></a>
<a name="//apple_ref/swift/Property/hasAsset" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8hasAssetSb">hasAsset</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tells you if there is an asset associated with this entity.</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">var</span> <span class="nv">hasAsset</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="k">asset</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">fileMetaData</span><span class="p">?</span><span class="o">.</span><span class="n">contentLength</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVSs10DictionarySSPSs9AnyObject__"></a>
<a name="//apple_ref/swift/Property/jsonObjectValue" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVSs10DictionarySSPSs9AnyObject__">jsonObjectValue</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 object value.</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">var</span> <span class="nv">jsonObjectValue</span> <span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">properties</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK14UsergridEntity11stringValueSS"></a>
<a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11stringValueSS">stringValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The string value.</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">var</span> <span class="nv">stringValue</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">NSString</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="k">try!</span> <span class="kt">NSJSONSerialization</span><span class="o">.</span><span class="nf">dataWithJSONObject</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">jsonObjectValue</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="o">.</span><span class="kt">PrettyPrinted</span><span class="p">),</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">NSUTF8StringEncoding</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity11descriptionSS"></a>
<a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11descriptionSS">description</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK14UsergridEntity16debugDescriptionSS"></a>
<a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK14UsergridEntity16debugDescriptionSS">debugDescription</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</span> <span class="p">:</span> <span class="kt">String</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:FC11UsergridSDK14UsergridEntitycFMS0_FT4typeSS4nameGSqSS_12propertyDictGSqGVSs10DictionarySSPSs9AnyObject____S0_"></a>
<a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFMS0_FT4typeSS4nameGSqSS_12propertyDictGSqGVSs10DictionarySSPSs9AnyObject____S0_">init(type:name:propertyDict:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Designated initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</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">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">name</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">propertyDict</span><span class="p">:[</span><span class="kt">String</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></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>The type associated with the <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The optional name associated with the <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>propertyDict</em>
</code>
</td>
<td>
<div>
<p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFMS0_FTSS10toSubclassMS0__T_"></a>
<a name="//apple_ref/swift/Method/mapCustomType(_:toSubclass:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFMS0_FTSS10toSubclassMS0__T_">mapCustomType(_:toSubclass:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Used for custom mapping subclasses to a given <code><a href="../Classes/Usergrid.html">Usergrid</a></code> type.</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">static</span> <span class="kd">func</span> <span class="nf">mapCustomType</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">toSubclass</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="o">.</span><span class="k">Type</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>The type of the <code>Usergrid</code> object.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>toSubclass</em>
</code>
</td>
<td>
<div>
<p>The subclass <code>UsergridEntity.Type</code> to map it to.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:ZFC11UsergridSDK14UsergridEntity6entityFMS0_FT8jsonDictGVSs10DictionarySSPSs9AnyObject___GSqS0__"></a>
<a name="//apple_ref/swift/Method/entity(jsonDict:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity6entityFMS0_FT8jsonDictGVSs10DictionarySSPSs9AnyObject___GSqS0__">entity(jsonDict:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Class convenience constructor for creating <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entity</span><span class="p">(</span><span class="n">jsonDict</span> <span class="nv">jsonDict</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kt">UsergridEntity</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>jsonDict</em>
</code>
</td>
<td>
<div>
<p>A valid JSON dictionary which must contain at the very least a value for the <code>type</code> key.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object provided that the <code><a href="../Classes/UsergridEntity.html#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a></code> key within the dictionay exists. Otherwise nil.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:ZFC11UsergridSDK14UsergridEntity8entitiesFMS0_FT9jsonArrayGSaGVSs10DictionarySSPSs9AnyObject____GSaS0__"></a>
<a name="//apple_ref/swift/Method/entities(jsonArray:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity8entitiesFMS0_FT9jsonArrayGSaGVSs10DictionarySSPSs9AnyObject____GSaS0__">entities(jsonArray:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Class convenience constructor for creating multiple <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entities</span><span class="p">(</span><span class="n">jsonArray</span> <span class="nv">entitiesJSONArray</span><span class="p">:</span> <span class="p">[[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]])</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>entitiesJSONArray</em>
</code>
</td>
<td>
<div>
<p>An array which contains dictionaries that are used to create the <code>UsergridEntity</code> objects.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An array of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/NSCoding"></a>
<a name="//apple_ref/swift/Section/NSCoding" class="dashAnchor"></a>
<a href="#/NSCoding">
<h3 class="section-name">NSCoding</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntitycFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
<a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFMS0_FT5coderCSo7NSCoder_GSqS0__">init(coder:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>NSCoding protocol initializer.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>aDecoder</em>
</code>
</td>
<td>
<div>
<p>The decoder.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
<a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity15encodeWithCoderFS0_FCSo7NSCoderT_">encodeWithCoder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>NSCoding protocol encoder.</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">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>aCoder</em>
</code>
</td>
<td>
<div>
<p>The encoder.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Property%20Manipulation"></a>
<a name="//apple_ref/swift/Section/Property Manipulation" class="dashAnchor"></a>
<a href="#/Property%20Manipulation">
<h3 class="section-name">Property Manipulation</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity11putPropertyFS0_FTSS5valueGSqPSs9AnyObject___T_"></a>
<a name="//apple_ref/swift/Method/putProperty(_:value:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity11putPropertyFS0_FTSS5valueGSqPSs9AnyObject___T_">putProperty(_:value:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Updates a properties value for the given property name.</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">putProperty</span><span class="p">(</span><span class="nv">name</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">AnyObject</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>value</em>
</code>
</td>
<td>
<div>
<p>The value to update to.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity13putPropertiesFS0_FGVSs10DictionarySSPSs9AnyObject__T_"></a>
<a name="//apple_ref/swift/Method/putProperties(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity13putPropertiesFS0_FGVSs10DictionarySSPSs9AnyObject__T_">putProperties(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Updates a set of properties that are within the given properties dictionary.</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">putProperties</span><span class="p">(</span><span class="nv">properties</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>properties</em>
</code>
</td>
<td>
<div>
<p>The property dictionary containing the properties names and values.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity14removePropertyFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/removeProperty(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity14removePropertyFS0_FSST_">removeProperty(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes the property for the given property name.</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">removeProperty</span><span class="p">(</span><span class="nv">name</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>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity16removePropertiesFS0_FGSaSS_T_"></a>
<a name="//apple_ref/swift/Method/removeProperties(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity16removePropertiesFS0_FGSaSS_T_">removeProperties(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes the properties with the names within the propertyNames array</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">removeProperties</span><span class="p">(</span><span class="nv">propertyNames</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>propertyNames</em>
</code>
</td>
<td>
<div>
<p>An array of property names.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6appendFS0_FTSS5valuePSs9AnyObject__T_"></a>
<a name="//apple_ref/swift/Method/append(_:value:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6appendFS0_FTSS5valuePSs9AnyObject__T_">append(_:value:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Appends the given value to the end of the properties current value.</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">append</span><span class="p">(</span><span class="nv">name</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">AnyObject</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>value</em>
</code>
</td>
<td>
<div>
<p>The value or an array of values to append.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6insertFS0_FTSS5valuePSs9AnyObject_5indexSi_T_"></a>
<a name="//apple_ref/swift/Method/insert(_:value:index:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6insertFS0_FTSS5valuePSs9AnyObject_5indexSi_T_">insert(_:value:index:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Inserts the given value at the given index within the properties current value.</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">insert</span><span class="p">(</span><span class="nv">name</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">AnyObject</span><span class="p">,</span> <span class="nv">index</span><span class="p">:</span><span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>index</em>
</code>
</td>
<td>
<div>
<p>The index to insert at.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>value</em>
</code>
</td>
<td>
<div>
<p>The value or an array of values to insert.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity3popFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/pop(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity3popFS0_FSST_">pop(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes the last value of the properties current value.</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">pop</span><span class="p">(</span><span class="nv">name</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>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity5shiftFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/shift(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity5shiftFS0_FSST_">shift(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes the first value of the properties current value.</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">shift</span><span class="p">(</span><span class="nv">name</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>name</em>
</code>
</td>
<td>
<div>
<p>The name of the property.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/CRUD%20Convenience%20Methods"></a>
<a name="//apple_ref/swift/Section/CRUD Convenience Methods" class="dashAnchor"></a>
<a href="#/CRUD%20Convenience%20Methods">
<h3 class="section-name">CRUD Convenience Methods</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6reloadFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/reload(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">reload</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6reloadFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/reload(_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">reload</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when reloading.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity4saveFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_">save(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">save</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity4saveFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">save(_:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when saving.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6removeFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/remove(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6removeFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_">remove(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a DELETE on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">remove</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity6removeFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/remove(_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6removeFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">remove(_:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Performs a DELETE on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">remove</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when removing.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Asset%20Management"></a>
<a name="//apple_ref/swift/Section/Asset Management" class="dashAnchor"></a>
<a href="#/Asset%20Management">
<h3 class="section-name">Asset Management</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity11uploadAssetFS0_FTCS_13UsergridAsset8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS2__T__10completionGSqFT8responseCS_16UsergridResponse5assetGSqS1__5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/uploadAsset(_:progress:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity11uploadAssetFS0_FTCS_13UsergridAsset8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS2__T__10completionGSqFT8responseCS_16UsergridResponse5assetGSqS1__5errorGSqSS__T___T_">uploadAsset(_:progress:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Uploads the given <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> and the data within it and creates an association between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> with the given <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">uploadAsset</span><span class="p">(</span><span class="k">as</span><span class="nv">set</span><span class="p">:</span><span class="kt">UsergridAsset</span><span class="p">,</span> <span class="nv">progress</span><span class="p">:</span><span class="kt">UsergridAssetRequestProgress</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridAssetUploadCompletion</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>asset</em>
</code>
</td>
<td>
<div>
<p>The <code>UsergridAsset</code> object to upload.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>progress</em>
</code>
</td>
<td>
<div>
<p>An optional progress block to keep track of upload progress.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity11uploadAssetFS0_FTCS_14UsergridClient5assetCS_13UsergridAsset8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS3__T__10completionGSqFT8responseCS_16UsergridResponse5assetGSqS2__5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/uploadAsset(_:asset:progress:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity11uploadAssetFS0_FTCS_14UsergridClient5assetCS_13UsergridAsset8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS3__T__10completionGSqFT8responseCS_16UsergridResponse5assetGSqS2__5errorGSqSS__T___T_">uploadAsset(_:asset:progress:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Uploads the given <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> and the data within it and creates an association between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> with the given <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code>.</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">uploadAsset</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="k">as</span><span class="nv">set</span><span class="p">:</span><span class="kt">UsergridAsset</span><span class="p">,</span> <span class="nv">progress</span><span class="p">:</span><span class="kt">UsergridAssetRequestProgress</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridAssetUploadCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when uploading.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>asset</em>
</code>
</td>
<td>
<div>
<p>The <code>UsergridAsset</code> object to upload.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>progress</em>
</code>
</td>
<td>
<div>
<p>An optional progress block to keep track of upload progress.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity13downloadAssetFS0_FTSS8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS1__T__10completionGSqFT5assetGSqCS_13UsergridAsset_5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/downloadAsset(_:progress:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity13downloadAssetFS0_FTSS8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS1__T__10completionGSqFT5assetGSqCS_13UsergridAsset_5errorGSqSS__T___T_">downloadAsset(_:progress:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Downloads the <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> that is associated with this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">downloadAsset</span><span class="p">(</span><span class="nv">contentType</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">progress</span><span class="p">:</span><span class="kt">UsergridAssetRequestProgress</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridAssetDownloadCompletion</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>contentType</em>
</code>
</td>
<td>
<div>
<p>The content type of the data to load.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>progress</em>
</code>
</td>
<td>
<div>
<p>An optional progress block to keep track of download progress.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity13downloadAssetFS0_FTCS_14UsergridClient11contentTypeSS8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS2__T__10completionGSqFT5assetGSqCS_13UsergridAsset_5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/downloadAsset(_:contentType:progress:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity13downloadAssetFS0_FTCS_14UsergridClient11contentTypeSS8progressGSqFT13bytesFinishedVSs5Int6413bytesExpectedS2__T__10completionGSqFT5assetGSqCS_13UsergridAsset_5errorGSqSS__T___T_">downloadAsset(_:contentType:progress:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Downloads the <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> that is associated with this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">downloadAsset</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">contentType</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">progress</span><span class="p">:</span><span class="kt">UsergridAssetRequestProgress</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridAssetDownloadCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when uploading.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>contentType</em>
</code>
</td>
<td>
<div>
<p>The content type of the data to load.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>progress</em>
</code>
</td>
<td>
<div>
<p>An optional progress block to keep track of download progress.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Connection%20Management"></a>
<a name="//apple_ref/swift/Section/Connection Management" class="dashAnchor"></a>
<a href="#/Connection%20Management">
<h3 class="section-name">Connection Management</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity7connectFS0_FTSS8toEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/connect(_:toEntity:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity7connectFS0_FTSS8toEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_">connect(_:toEntity:completion:)</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 relationship between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> and the given entity using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">connect</span><span class="p">(</span><span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">toEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>toEntity</em>
</code>
</td>
<td>
<div>
<p>The entity to connect.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity7connectFS0_FTCS_14UsergridClient12relationshipSS8toEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/connect(_:relationship:toEntity:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity7connectFS0_FTCS_14UsergridClient12relationshipSS8toEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_">connect(_:relationship:toEntity:completion:)</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 relationship between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> and the given entity.</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">connect</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">toEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when connecting.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>toEntity</em>
</code>
</td>
<td>
<div>
<p>The entity to connect.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity10disconnectFS0_FTSS10fromEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/disconnect(_:fromEntity:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity10disconnectFS0_FTSS10fromEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_">disconnect(_:fromEntity:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes a relationship between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> and the given entity using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">disconnect</span><span class="p">(</span><span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fromEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fromEntity</em>
</code>
</td>
<td>
<div>
<p>The entity to disconnect.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity10disconnectFS0_FTCS_14UsergridClient12relationshipSS10fromEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/disconnect(_:relationship:fromEntity:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity10disconnectFS0_FTCS_14UsergridClient12relationshipSS10fromEntityS0_10completionGSqFT8responseCS_16UsergridResponse_T___T_">disconnect(_:relationship:fromEntity:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Removes a relationship between this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> and the given entity.</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">disconnect</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fromEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when disconnecting.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fromEntity</em>
</code>
</td>
<td>
<div>
<p>The entity to disconnect.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity14getConnectionsFS0_FTOS_17UsergridDirection12relationshipSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/getConnections(_:relationship:query:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity14getConnectionsFS0_FTOS_17UsergridDirection12relationshipSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">getConnections(_:relationship:query:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Gets the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects, if any, which are connected via the relationship using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">getConnections</span><span class="p">(</span><span class="nv">direction</span><span class="p">:</span><span class="kt">UsergridDirection</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</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="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>direction</em>
</code>
</td>
<td>
<div>
<p>The direction of the connection.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>query</em>
</code>
</td>
<td>
<div>
<p>The optional query.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK14UsergridEntity14getConnectionsFS0_FTCS_14UsergridClient9directionOS_17UsergridDirection12relationshipSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/getConnections(_:direction:relationship:query:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK14UsergridEntity14getConnectionsFS0_FTCS_14UsergridClient9directionOS_17UsergridDirection12relationshipSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">getConnections(_:direction:relationship:query:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Gets the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects, if any, which are connected via the relationship.</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">getConnections</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">direction</span><span class="p">:</span><span class="kt">UsergridDirection</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</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="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>client</em>
</code>
</td>
<td>
<div>
<p>The client to use when getting the connected <code>UsergridEntity</code> objects.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>direction</em>
</code>
</td>
<td>
<div>
<p>The direction of the connection.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>relationship</em>
</code>
</td>
<td>
<div>
<p>The relationship type.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>query</em>
</code>
</td>
<td>
<div>
<p>The optional query.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>An optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift" target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</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>