| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>Typealiases 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 title="Typealiases 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" /> |
| Typealiases 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>Typealiases</h1> |
| <p>The following typealiases are available globally.</p> |
| |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK30UsergridAppAuthCompletionBlock"></a> |
| <a name="//apple_ref/swift/Alias/UsergridAppAuthCompletionBlock" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used in <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridAppAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK31UsergridUserAuthCompletionBlock"></a> |
| <a name="//apple_ref/swift/Alias/UsergridUserAuthCompletionBlock" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used in <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridUserAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridUserAuth</span><span class="p">?,</span> <span class="nv">user</span><span class="p">:</span><span class="kt">UsergridUser</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK34UsergridUserAvailabilityCompletion"></a> |
| <a name="//apple_ref/swift/Alias/UsergridUserAvailabilityCompletion" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used for checking email and/or username availablity for new <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserAvailabilityCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">available</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK35UsergridUserResetPasswordCompletion"></a> |
| <a name="//apple_ref/swift/Alias/UsergridUserResetPasswordCompletion" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used for changing the password of <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserResetPasswordCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">didSucceed</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK26UsergridResponseCompletion"></a> |
| <a name="//apple_ref/swift/Alias/UsergridResponseCompletion" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used in for most <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> requests.</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">typealias</span> <span class="kt">UsergridResponseCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK28UsergridAssetRequestProgress"></a> |
| <a name="//apple_ref/swift/Alias/UsergridAssetRequestProgress" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The progress block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are being uploaded or downloaded.</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">typealias</span> <span class="kt">UsergridAssetRequestProgress</span> <span class="o">=</span> <span class="p">(</span><span class="nv">bytesFinished</span><span class="p">:</span><span class="kt">Int64</span><span class="p">,</span> <span class="nv">bytesExpected</span><span class="p">:</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK29UsergridAssetUploadCompletion"></a> |
| <a name="//apple_ref/swift/Alias/UsergridAssetUploadCompletion" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished uploading.</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">typealias</span> <span class="kt">UsergridAssetUploadCompletion</span> <span class="o">=</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">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:11UsergridSDK31UsergridAssetDownloadCompletion"></a> |
| <a name="//apple_ref/swift/Alias/UsergridAssetDownloadCompletion" class="dashAnchor"></a> |
| <a class="token" href="#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished downloading.</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">typealias</span> <span class="kt">UsergridAssetDownloadCompletion</span> <span class="o">=</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">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| <section id="footer"> |
| <p>© 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> |
