http://git-wip-us.apache.org/repos/asf/usergrid/blob/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html new file mode 100644 index 0000000..579c1e1 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html @@ -0,0 +1,319 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAppAuth 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/UsergridAppAuth" class="dashAnchor"></a> + <a title="UsergridAppAuth Class Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridAppAuth 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/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/UsergridResponse.html">UsergridResponse</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="../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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAppAuth</h1> + <div class="declaration"> + <div class="Swift"> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> + + </div> + </div> + <p>The <code>UsergridAuth</code> subclass used for application level authorization.</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:vC11UsergridSDK15UsergridAppAuth8clientIDSS"></a> + <a name="//apple_ref/swift/Property/clientID" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridAppAuth8clientIDSS">clientID</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The client identifier associated with the application.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">clientID</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:FC11UsergridSDK15UsergridAppAuthcFMS0_FT8clientIDSS12clientSecretSS_S0_"></a> + <a name="//apple_ref/swift/Method/init(clientID:clientSecret:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFMS0_FT8clientIDSS12clientSecretSS_S0_">init(clientID:clientSecret:)</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>UsergridAppAuth</code> objects.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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">clientID</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">clientSecret</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>clientID</em> + </code> + </td> + <td> + <div> + <p>The client identifier associated with the application.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>clientSecret</em> + </code> + </td> + <td> + <div> + <p>The client secret associated with the application.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code>UsergridAppAuth</code>.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK15UsergridAppAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFMS0_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>Undocumented</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a> + <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_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>Undocumented</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.3.2</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/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html new file mode 100644 index 0000000..bf2b9f7 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html @@ -0,0 +1,557 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAsset 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/UsergridAsset" class="dashAnchor"></a> + <a title="UsergridAsset Class Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridAsset 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/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/UsergridResponse.html">UsergridResponse</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="../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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAsset</h1> + <div class="declaration"> + <div class="Swift"> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAsset</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre> + + </div> + </div> + <p>As Usergrid supports storing binary assets, the SDKs are designed to make uploading assets easier and more robust. Attaching, uploading, and downloading assets is handled by the <code>UsergridEntity</code> class.</p> + +<p>Unless defined, whenever possible, the content-type will be inferred from the data provided, and the attached file (if not already a byte-array representation) will be binary-encoded.</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:vC11UsergridSDK13UsergridAsset8fileNameSS"></a> + <a name="//apple_ref/swift/Property/fileName" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset8fileNameSS">fileName</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The filename to be used in the multipart/form-data request.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">fileName</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:vC11UsergridSDK13UsergridAsset9assetDataCSo6NSData"></a> + <a name="//apple_ref/swift/Property/assetData" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset9assetDataCSo6NSData">assetData</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Binary representation of asset data. If an image or image path was passed on initialization of the <code>UsergridAsset</code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">assetData</span><span class="p">:</span> <span class="kt">NSData</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK13UsergridAsset16originalLocationGSqSS_"></a> + <a name="//apple_ref/swift/Property/originalLocation" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset16originalLocationGSqSS_">originalLocation</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A representation of the folder location the asset was loaded from, if it was provided in the initialization.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">originalLocation</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK13UsergridAsset11contentTypeSS"></a> + <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset11contentTypeSS">contentType</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The Content-type of the asset to be used when defining content-type inside the multipart/form-data request.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">contentType</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:vC11UsergridSDK13UsergridAsset13contentLengthSi"></a> + <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset13contentLengthSi">contentLength</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The content length of the assets data.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">contentLength</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="k">as</span><span class="n">setData</span><span class="o">.</span><span class="n">length</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:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_"></a> + <a name="//apple_ref/swift/Method/init(fileName:data:originalLocation:contentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_">init(fileName:data:originalLocation:contentType:)</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>UsergridAsset</code> objects.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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">fileName</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span><span class="kt">NSData</span><span class="p">,</span> <span class="nv">originalLocation</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">contentType</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>fileName</em> + </code> + </td> + <td> + <div> + <p>The file name associated with the file data.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>data</em> + </code> + </td> + <td> + <div> + <p>The data of the file.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>originalLocation</em> + </code> + </td> + <td> + <div> + <p>An optional original location of the file.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>contentType</em> + </code> + </td> + <td> + <div> + <p>The content type of the file.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code>UsergridAsset</code>.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(fileName:image:imageContentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__">init(fileName:image:imageContentType:)</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>UsergridAsset</code> objects dealing with image data.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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">fileName</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</span><span class="p">,</span> <span class="nv">image</span><span class="p">:</span><span class="kt">UIImage</span><span class="p">,</span> <span class="nv">imageContentType</span><span class="p">:</span><span class="kt">UsergridImageContentType</span> <span class="o">=</span> <span class="o">.</span><span class="kt">Png</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>fileName</em> + </code> + </td> + <td> + <div> + <p>The file name associated with the file data.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>image</em> + </code> + </td> + <td> + <div> + <p>The <code>UIImage</code> object to upload.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>imageContentType</em> + </code> + </td> + <td> + <div> + <p>The content type of the <code>UIImage</code></p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code>UsergridAsset</code> if the data can be gathered from the passed in <code>UIImage</code>, otherwise nil.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(fileName:fileURL:contentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__">init(fileName:fileURL:contentType:)</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>UsergridAsset</code> objects dealing directly with files on disk.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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="k">var</span> <span class="nv">fileName</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</span><span class="p">,</span> <span class="nv">fileURL</span><span class="p">:</span><span class="kt">NSURL</span><span class="p">,</span> <span class="k">var</span> <span class="nv">contentType</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>fileName</em> + </code> + </td> + <td> + <div> + <p>The file name associated with the file data.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>fileURL</em> + </code> + </td> + <td> + <div> + <p>The <code>NSURL</code> object associated with the file.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>contentType</em> + </code> + </td> + <td> + <div> + <p>The content type of the <code>UIImage</code>. If not specified it will try to figure out the type and if it can’t initialization will fail.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code>UsergridAsset</code> if the data can be gathered from the passed in <code>NSURL</code>, otherwise nil.</p> + + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.3.2</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/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html new file mode 100644 index 0000000..12ae462 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html @@ -0,0 +1,380 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAuth 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/UsergridAuth" class="dashAnchor"></a> + <a title="UsergridAuth Class Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridAuth 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/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/UsergridResponse.html">UsergridResponse</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="../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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAuth</h1> + <div class="declaration"> + <div class="Swift"> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> + + </div> + </div> + <p>The base class for <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> classes.</p> + +<p>This class should never be initialized on its own. The use of the <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> subclasses should be used.</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:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a> + <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The access token, if this <code>UsergridAuth</code> was authorized successfully.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">accessToken</span> <span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK12UsergridAuth9expiresInGSqSi_"></a> + <a name="//apple_ref/swift/Property/expiresIn" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9expiresInGSqSi_">expiresIn</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The expires in time stamp, if this <code>UsergridAuth</code> was authorized successfully and their was a expires in time stamp within the token response.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">expiresIn</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK12UsergridAuth8hasTokenSb"></a> + <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Determines if an access token exists.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">hasToken</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="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK12UsergridAuth12tokenIsValidSb"></a> + <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth12tokenIsValidSb">tokenIsValid</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Determines if an access token exists and if the token is not expired.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tokenIsValid</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="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK12UsergridAuth9isExpiredSb"></a> + <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Determines if the access token, if one exists, is expired.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isExpired</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridAuthcFMS0_FT_S0_"></a> + <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT_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>Undocumented</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_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>Undocumented</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a> + <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_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>Undocumented</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.3.2</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html>
