http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridClientConfig.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridClientConfig.html b/sdks/swift/docs/Classes/UsergridClientConfig.html deleted file mode 100644 index b7abeab..0000000 --- a/sdks/swift/docs/Classes/UsergridClientConfig.html +++ /dev/null @@ -1,744 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridClientConfig 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/UsergridClientConfig" class="dashAnchor"></a> - <a title="UsergridClientConfig Class Reference"></a> - <header> - <div class="content-wrapper"> - <p><a href="../index.html"> Docs</a> (100% documented)</p> - </div> - </header> - <div class="content-wrapper"> - <p id="breadcrumbs"> - <a href="../index.html"> Reference</a> - <img id="carat" src="../img/carat.png" /> - UsergridClientConfig Class Reference - </p> - </div> - <div class="content-wrapper"> - <nav class="sidebar"> - <ul class="nav-groups"> - <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Classes/Usergrid.html">Usergrid</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAsset.html">UsergridAsset</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAuth.html">UsergridAuth</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridClient.html">UsergridClient</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridDevice.html">UsergridDevice</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridEntity.html">UsergridEntity</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridQuery.html">UsergridQuery</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridRequest.html">UsergridRequest</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridResponse.html">UsergridResponse</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridUser.html">UsergridUser</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Global Variables.html">Global Variables</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridDirection.html">UsergridDirection</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Extensions.html">Extensions</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Extensions/NSDate.html">NSDate</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> - </li> - </ul> - </li> - </ul> - </nav> - <article class="main-content"> - <section> - <section class="section"> - <h1>UsergridClientConfig</h1> - <div class="declaration"> - <div class="language"> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClientConfig</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>UsergridClientConfig</code> is used when initializing <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects.</p> - -<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Instance%20Properties"></a> - <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> - <a href="#/Instance%20Properties"> - <h3 class="section-name">Instance Properties</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK20UsergridClientConfig5orgIdSS"></a> - <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5orgIdSS">orgId</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The organization identifier.</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">orgId</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:vC11UsergridSDK20UsergridClientConfig5appIdSS"></a> - <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5appIdSS">appId</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The application identifier.</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">appId</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:vC11UsergridSDK20UsergridClientConfig7baseUrlSS"></a> - <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7baseUrlSS">baseUrl</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The base URL that all calls will be made with.</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">baseUrl</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">UsergridClient</span><span class="o">.</span><span class="kt">DEFAULT_BASE_URL</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode"></a> - <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode">authMode</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="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</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">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</span> <span class="o">=</span> <span class="o">.</span><span class="kt">User</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb"></a> - <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Whether or not the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_"></a> - <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_">appAuth</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p> - -<p>Note that you still need to call the authentication methods within <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> once it has been initialized.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Initialization"></a> - <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> - <a href="#/Initialization"> - <h3 class="section-name">Initialization</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_"></a> - <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</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/UsergridClientConfig.html">UsergridClientConfig</a></code> objects.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em> - </code> - </td> - <td> - <div> - <p>The organization identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appId</em> - </code> - </td> - <td> - <div> - <p>The application identifier.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a> - <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Convenience initializer for <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em> - </code> - </td> - <td> - <div> - <p>The organization identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appId</em> - </code> - </td> - <td> - <div> - <p>The application identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>baseUrl</em> - </code> - </td> - <td> - <div> - <p>The base URL that all calls will be made with.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_"></a> - <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_">init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Convenience initializer for <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">authMode</span><span class="p">:</span><span class="kt">UsergridAuthMode</span><span class="p">,</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">appAuth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</s pan></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>orgId</em> - </code> - </td> - <td> - <div> - <p>The organization identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appId</em> - </code> - </td> - <td> - <div> - <p>The application identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>baseUrl</em> - </code> - </td> - <td> - <div> - <p>The base URL that all calls will be made with.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>authMode</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridAuthMode</code> value used to determine what type of token will be sent, if any.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>persistCurrentUserInKeychain</em> - </code> - </td> - <td> - <div> - <p>Whether or not the <code>UsergridClient</code> current user will be saved and restored from the keychain.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appAuth</em> - </code> - </td> - <td> - <div> - <p>The application level <code>UsergridAppAuth</code> object.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</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:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_GSqS0__"></a> - <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_"></a> - <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_">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> - </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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridDevice.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridDevice.html b/sdks/swift/docs/Classes/UsergridDevice.html deleted file mode 100644 index 9cda8aa..0000000 --- a/sdks/swift/docs/Classes/UsergridDevice.html +++ /dev/null @@ -1,763 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridDevice 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/UsergridDevice" class="dashAnchor"></a> - <a title="UsergridDevice Class Reference"></a> - <header> - <div class="content-wrapper"> - <p><a href="../index.html"> Docs</a> (100% documented)</p> - </div> - </header> - <div class="content-wrapper"> - <p id="breadcrumbs"> - <a href="../index.html"> Reference</a> - <img id="carat" src="../img/carat.png" /> - UsergridDevice Class Reference - </p> - </div> - <div class="content-wrapper"> - <nav class="sidebar"> - <ul class="nav-groups"> - <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Classes/Usergrid.html">Usergrid</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAsset.html">UsergridAsset</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridAuth.html">UsergridAuth</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridClient.html">UsergridClient</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridDevice.html">UsergridDevice</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridEntity.html">UsergridEntity</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridQuery.html">UsergridQuery</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridRequest.html">UsergridRequest</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridResponse.html">UsergridResponse</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridUser.html">UsergridUser</a> - </li> - <li class="nav-group-task"> - <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Global Variables.html">Global Variables</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridDirection.html">UsergridDirection</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a> - </li> - <li class="nav-group-task"> - <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Extensions.html">Extensions</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Extensions/NSDate.html">NSDate</a> - </li> - </ul> - </li> - <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> - <ul class="nav-group-tasks"> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> - </li> - <li class="nav-group-task"> - <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> - </li> - </ul> - </li> - </ul> - </nav> - <article class="main-content"> - <section> - <section class="section"> - <h1>UsergridDevice</h1> - <div class="declaration"> - <div class="language"> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre> - - </div> - </div> - <p><code>UsergridDevice</code> is an <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p> - -<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__"></a> - <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__">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/UsergridDevice.html">UsergridDevice</a></code> class. Note that all of the <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> are immutable.</p> - -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - <p>When setting a properties value must be a valid JSON object.</p> - -</div> - -<p><li><p>Example usage: -<code> -let uuid = usergridDevice["uuid"] -</code></p></li></p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="k">override</span> <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">-></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:vC11UsergridSDK14UsergridDevice5modelSS"></a> - <a name="//apple_ref/swift/Property/model" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice5modelSS">model</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/UsergridDevice.html">UsergridDevice</a></code> objects device model.</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">model</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Model</span><span class="o">.</span><span class="n">stringValue</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:vC11UsergridSDK14UsergridDevice8platformSS"></a> - <a name="//apple_ref/swift/Property/platform" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice8platformSS">platform</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/UsergridDevice.html">UsergridDevice</a></code> objects device platform.</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">platform</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Platform</span><span class="o">.</span><span class="n">stringValue</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:vC11UsergridSDK14UsergridDevice9osVersionSS"></a> - <a name="//apple_ref/swift/Property/osVersion" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice9osVersionSS">osVersion</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/UsergridDevice.html">UsergridDevice</a></code> objects device operating system version.</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">osVersion</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">OSVersion</span><span class="o">.</span><span class="n">stringValue</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:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_"></a> - <a name="//apple_ref/swift/Variable/sharedDevice" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">sharedDevice</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The shared instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</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">static</span> <span class="k">var</span> <span class="nv">sharedDevice</span><span class="p">:</span> <span class="kt">UsergridDevice</span> <span class="o">=</span> <span class="kt">UsergridDevice</span><span class="o">.</span><span class="nf">getOrCreateSharedDeviceFromKeychain</span><span class="p">()</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Initialization"></a> - <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> - <a href="#/Initialization"> - <h3 class="section-name">Initialization</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridDevicecFT_S0_"></a> - <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT_S0_">init()</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/UsergridDevice.html">UsergridDevice</a></code> objects</p> - -<p>Most likely you will never need to create seperate instances of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>. Use of <code>UsergridDevice.sharedInstance</code> is recommended.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre> - - </div> - </div> - <div> - <h4>Return Value</h4> - <p>A new instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a> - <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____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>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</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/UsergridDevice.html">UsergridDevice</a></code> object.</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:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_GSqS0__"></a> - <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_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:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_"></a> - <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_">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="k">override</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> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_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/UsergridDevice.html">UsergridDevice</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - -<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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="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:FC11UsergridSDK14UsergridDevice4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTCS_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/UsergridDevice.html">UsergridDevice</a></code>.</p> - -<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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="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:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_"></a> - <a name="//apple_ref/swift/Method/saveSharedDeviceToKeychain()" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_">saveSharedDeviceToKeychain()</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Saves the <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> to the keychain.</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">saveSharedDeviceToKeychain</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="/Class%20Helper%20Methods"></a> - <a name="//apple_ref/swift/Section/Class Helper Methods" class="dashAnchor"></a> - <a href="#/Class%20Helper%20Methods"> - <h3 class="section-name">Class Helper Methods</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__"></a> - <a name="//apple_ref/swift/Method/commonDevicePropertyDict()" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__">commonDevicePropertyDict()</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 property dictionary that contains the common properties for <code><a href="../Classes/UsergridDevice.html">UsergridDevice</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">static</span> <span class="kd">func</span> <span class="nf">commonDevicePropertyDict</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]</span></code></pre> - - </div> - </div> - <div> - <h4>Return Value</h4> - <p>A property dictionary with the common properties set.</p> - - </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>
