You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2016/02/16 14:15:15 UTC
[23/75] [partial] usergrid git commit: Initial commit of the Swift
SDK.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/7442c881/sdks/swift/docs/Classes/UsergridFileMetaData.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridFileMetaData.html b/sdks/swift/docs/Classes/UsergridFileMetaData.html
new file mode 100644
index 0000000..ec2d077
--- /dev/null
+++ b/sdks/swift/docs/Classes/UsergridFileMetaData.html
@@ -0,0 +1,524 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <title>UsergridFileMetaData 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/UsergridFileMetaData" class="dashAnchor"></a>
+ <a title="UsergridFileMetaData Class Reference"></a>
+ <header>
+ <div class="content-wrapper">
+ <p><a href="../index.html">UsergridSDK Docs</a> (100% documented)</p>
+ </div>
+ </header>
+ <div class="content-wrapper">
+ <p id="breadcrumbs">
+ <a href="../index.html">UsergridSDK Reference</a>
+ <img id="carat" src="../img/carat.png" />
+ UsergridFileMetaData Class Reference
+ </p>
+ </div>
+ <div class="content-wrapper">
+ <nav class="sidebar">
+ <ul class="nav-groups">
+ <li class="nav-group-name">
+ <a href="../Classes.html">Classes</a>
+ <ul class="nav-group-tasks">
+ <li class="nav-group-task">
+ <a href="../Classes/Usergrid.html">Usergrid</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridAsset.html">UsergridAsset</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridAuth.html">UsergridAuth</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridClient.html">UsergridClient</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridDevice.html">UsergridDevice</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridEntity.html">UsergridEntity</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridQuery.html">UsergridQuery</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridRequest.html">UsergridRequest</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridResponse.html">UsergridResponse</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridUser.html">UsergridUser</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a>
+ </li>
+ </ul>
+ </li>
+ <li class="nav-group-name">
+ <a href="../Global Variables.html">Global Variables</a>
+ <ul class="nav-group-tasks">
+ <li class="nav-group-task">
+ <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a>
+ </li>
+ </ul>
+ </li>
+ <li class="nav-group-name">
+ <a href="../Enums.html">Enums</a>
+ <ul class="nav-group-tasks">
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridDirection.html">UsergridDirection</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a>
+ </li>
+ </ul>
+ </li>
+ <li class="nav-group-name">
+ <a href="../Typealiases.html">Typealiases</a>
+ <ul class="nav-group-tasks">
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a>
+ </li>
+ <li class="nav-group-task">
+ <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+ <article class="main-content">
+ <section>
+ <section class="section">
+ <h1>UsergridFileMetaData</h1>
+ <div class="declaration">
+ <div class="language">
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridFileMetaData</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>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</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:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_"></a>
+ <a name="//apple_ref/swift/Property/eTag" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_">eTag</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>The eTag.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eTag</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:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_"></a>
+ <a name="//apple_ref/swift/Property/checkSum" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_">checkSum</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>The check sum.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">checkSum</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:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_"></a>
+ <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_">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 associated with the file data.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">contentType</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:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi"></a>
+ <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi">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 file data.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">contentLength</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
+
+ </div>
+ </div>
+ </section>
+ </div>
+ </li>
+ <li class="item">
+ <div>
+ <code>
+ <a name="/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi"></a>
+ <a name="//apple_ref/swift/Property/lastModifiedTimeStamp" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi">lastModifiedTimeStamp</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>The last modified time stamp.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">lastModifiedTimeStamp</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
+
+ </div>
+ </div>
+ </section>
+ </div>
+ </li>
+ <li class="item">
+ <div>
+ <code>
+ <a name="/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_"></a>
+ <a name="//apple_ref/swift/Property/lastModifiedDate" class="dashAnchor"></a>
+ <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_">lastModifiedDate</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>NSDate</code> object corresponding to the last modified time stamp.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">lastModifiedDate</span><span class="p">:</span> <span class="kt">NSDate</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:FC11UsergridSDK20UsergridFileMetaDatacFMS0_FT16fileMetaDataJSONGVSs10DictionarySSPSs9AnyObject___S0_"></a>
+ <a name="//apple_ref/swift/Method/init(fileMetaDataJSON:)" class="dashAnchor"></a>
+ <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFMS0_FT16fileMetaDataJSONGVSs10DictionarySSPSs9AnyObject___S0_">init(fileMetaDataJSON:)</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/UsergridFileMetaData.html">UsergridFileMetaData</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">fileMetaDataJSON</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
+
+ </div>
+ </div>
+ <div>
+ <h4>Parameters</h4>
+ <table class="graybox">
+ <tbody>
+ <tr>
+ <td>
+ <code>
+ <em>fileMetaDataJSON</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The file meta data JSON dictionary.</p>
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div>
+ <h4>Return Value</h4>
+ <p>A new instance of <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</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:FC11UsergridSDK20UsergridFileMetaDatacFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
+ <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
+ <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFMS0_FT5coderCSo7NSCoder_GSqS0__">init(coder:)</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>NSCoding protocol initializer.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
+
+ </div>
+ </div>
+ <div>
+ <h4>Parameters</h4>
+ <table class="graybox">
+ <tbody>
+ <tr>
+ <td>
+ <code>
+ <em>aDecoder</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The decoder.</p>
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div>
+ <h4>Return Value</h4>
+ <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+
+ </div>
+ </section>
+ </div>
+ </li>
+ <li class="item">
+ <div>
+ <code>
+ <a name="/s:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
+ <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
+ <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFS0_FCSo7NSCoderT_">encodeWithCoder(_:)</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>NSCoding protocol encoder.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
+
+ </div>
+ </div>
+ <div>
+ <h4>Parameters</h4>
+ <table class="graybox">
+ <tbody>
+ <tr>
+ <td>
+ <code>
+ <em>aCoder</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The encoder.</p>
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </section>
+ </div>
+ </li>
+ </ul>
+ </div>
+ </section>
+ </section>
+ <section id="footer">
+ <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK" target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</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>