http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/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 index 579c1e1..c872daf 100644 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html @@ -7,13 +7,14 @@ <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> + <p><a href="../index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> @@ -27,7 +28,7 @@ <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> + <a href="../Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Classes/Usergrid.html">Usergrid</a> @@ -39,6 +40,9 @@ <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"> @@ -60,9 +64,15 @@ <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"> @@ -71,10 +81,18 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> + <a href="../Global Variables.html">Global Variables</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> - <a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a> + <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> @@ -86,6 +104,9 @@ <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"> @@ -100,7 +121,15 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> + <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> @@ -120,6 +149,12 @@ <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> @@ -129,30 +164,30 @@ <section class="section"> <h1>UsergridAppAuth</h1> <div class="declaration"> - <div class="Swift"> + <div class="language"> <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> + <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></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> + <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> + <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"> @@ -165,9 +200,9 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">clientID</span><span class="p">:</span> <span class="kt">String</span></code></pre> + <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> @@ -177,20 +212,20 @@ </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> + <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> + <a name="/s:FC11UsergridSDK15UsergridAppAuthcFT8clientIdSS12clientSecretSS_S0_"></a> + <a name="//apple_ref/swift/Method/init(clientId:clientSecret:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFT8clientIdSS12clientSecretSS_S0_">init(clientId:clientSecret:)</a> </code> </div> <div class="height-container"> @@ -198,14 +233,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridAppAuth</code> objects.</p> + <p>Designated initializer for <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">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> + <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> @@ -216,7 +251,7 @@ <tr> <td> <code> - <em>clientID</em> + <em>clientId</em> </code> </td> <td> @@ -244,18 +279,29 @@ </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridAppAuth</code>.</p> + <p>A new instance of <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</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:FC11UsergridSDK15UsergridAppAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a> + <a name="/s:FC11UsergridSDK15UsergridAppAuthcFT5coderCSo7NSCoder_GSqS0__"></a> <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__">init(coder:)</a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFT5coderCSo7NSCoder_GSqS0__">init(coder:)</a> </code> </div> <div class="height-container"> @@ -263,26 +309,51 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Undocumented</p> + <p>NSCoding protocol initializer.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> + <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:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a> + <a name="/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFCSo7NSCoderT_"></a> <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_FCSo7NSCoderT_">encodeWithCoder(_:)</a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFCSo7NSCoderT_">encodeWithCoder(_:)</a> </code> </div> <div class="height-container"> @@ -290,17 +361,37 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Undocumented</p> + <p>NSCoding protocol encoder.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> + <pre class="highlight"><code><span class="k">override</span> <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> @@ -309,8 +400,8 @@ </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> + <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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/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 index bf2b9f7..568d727 100644 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html @@ -7,13 +7,14 @@ <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> + <p><a href="../index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> @@ -27,7 +28,7 @@ <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> + <a href="../Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Classes/Usergrid.html">Usergrid</a> @@ -39,6 +40,9 @@ <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"> @@ -60,9 +64,15 @@ <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"> @@ -71,10 +81,18 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> + <a href="../Global Variables.html">Global Variables</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> - <a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a> + <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> @@ -86,6 +104,9 @@ <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"> @@ -100,7 +121,15 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> + <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> @@ -120,6 +149,12 @@ <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> @@ -129,32 +164,32 @@ <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 class="language"> + <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><span class="p">,</span> <span class="kt">NSCoding</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>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><a href="../Classes/UsergridEntity.html">UsergridEntity</a></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> + <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> + <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"> @@ -167,9 +202,9 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">fileName</span><span class="p">:</span> <span class="kt">String</span></code></pre> + <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> @@ -179,9 +214,9 @@ <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> + <a name="/s:vC11UsergridSDK13UsergridAsset4dataCSo6NSData"></a> + <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset4dataCSo6NSData">data</a> </code> </div> <div class="height-container"> @@ -189,14 +224,14 @@ <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> + <p>Binary representation of the asset’s data.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">assetData</span><span class="p">:</span> <span class="kt">NSData</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span></code></pre> </div> </div> @@ -221,7 +256,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">originalLocation</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -248,7 +283,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">contentType</span><span class="p">:</span> <span class="kt">String</span></code></pre> @@ -275,9 +310,9 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">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> + <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="n">data</span><span class="o">.</span><span class="n">length</span> <span class="p">}</span></code></pre> </div> </div> @@ -287,20 +322,20 @@ </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> + <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> + <a name="/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_"></a> + <a name="//apple_ref/swift/Method/init(filename:data:originalLocation:contentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_">init(filename:data:originalLocation:contentType:)</a> </code> </div> <div class="height-container"> @@ -308,14 +343,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridAsset</code> objects.</p> + <p>Designated initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">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> + <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> @@ -380,7 +415,7 @@ </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridAsset</code>.</p> + <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code>.</p> </div> </section> @@ -389,9 +424,9 @@ <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> + <a name="/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(filename:image:imageContentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__">init(filename:image:imageContentType:)</a> </code> </div> <div class="height-container"> @@ -399,14 +434,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Convenience initializer for <code>UsergridAsset</code> objects dealing with image data.</p> + <p>Convenience initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> objects dealing with image data.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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">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> + <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> @@ -458,7 +493,7 @@ </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> + <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> if the data can be gathered from the passed in <code>UIImage</code>, otherwise nil.</p> </div> </section> @@ -467,9 +502,9 @@ <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> + <a name="/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(filename:fileURL:contentType:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__">init(filename:fileURL:contentType:)</a> </code> </div> <div class="height-container"> @@ -477,14 +512,14 @@ <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> + <p>Convenience initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> objects dealing directly with files on disk.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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="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> + <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">fileURL</span><span class="p">:</span><span class="kt">NSURL</span><span class="p">,</span> <span class="nv">contentType</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -536,8 +571,118 @@ </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> + <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> if the data can be gathered from the passed in <code>NSURL</code>, otherwise nil.</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:FC11UsergridSDK13UsergridAssetcFT5coderCSo7NSCoder_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT5coderCSo7NSCoder_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:FC11UsergridSDK13UsergridAsset15encodeWithCoderFCSo7NSCoderT_"></a> + <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset15encodeWithCoderFCSo7NSCoderT_">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> @@ -547,8 +692,8 @@ </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> + <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> http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html new file mode 100644 index 0000000..f7a0b00 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html @@ -0,0 +1,356 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAssetUploadRequest 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/UsergridAssetUploadRequest" class="dashAnchor"></a> + <a title="UsergridAssetUploadRequest 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" /> + UsergridAssetUploadRequest 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>UsergridAssetUploadRequest</h1> + <div class="declaration"> + <div class="language"> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAssetUploadRequest</span><span class="p">:</span> <span class="kt">UsergridRequest</span></code></pre> + + </div> + </div> + <p>The <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sub class which is used for uploading assets.</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:vC11UsergridSDK26UsergridAssetUploadRequest5assetCS_13UsergridAsset"></a> + <a name="//apple_ref/swift/Property/asset" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK26UsergridAssetUploadRequest5assetCS_13UsergridAsset">asset</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The asset to use for uploading.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">asset</span><span class="p">:</span> <span class="kt">UsergridAsset</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK26UsergridAssetUploadRequest17multiPartHTTPBodyCSo6NSData"></a> + <a name="//apple_ref/swift/Property/multiPartHTTPBody" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK26UsergridAssetUploadRequest17multiPartHTTPBodyCSo6NSData">multiPartHTTPBody</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A constructed multipart http body for requests to upload.</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">multiPartHTTPBody</span><span class="p">:</span> <span class="kt">NSData</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:FC11UsergridSDK26UsergridAssetUploadRequestcFT7baseUrlSS5pathsGSqGSaSS__4authGSqCS_12UsergridAuth_5assetCS_13UsergridAsset_S0_"></a> + <a name="//apple_ref/swift/Method/init(baseUrl:paths:auth:asset:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK26UsergridAssetUploadRequestcFT7baseUrlSS5pathsGSqGSaSS__4authGSqCS_12UsergridAuth_5assetCS_13UsergridAsset_S0_">init(baseUrl:paths:auth:asset:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The designated initializer for <code><a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</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">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> + <span class="nv">paths</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">auth</span><span class="p">:</span><span class="kt">UsergridAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> + <span class="k">as</span><span class="nv">set</span><span class="p">:</span><span class="kt">UsergridAsset</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>baseUrl</em> + </code> + </td> + <td> + <div> + <p>The base URL.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>paths</em> + </code> + </td> + <td> + <div> + <p>The optional paths to append to the base URL.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>auth</em> + </code> + </td> + <td> + <div> + <p>The optional <code>UsergridAuth</code> that will be used in the Authorization header.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>asset</em> + </code> + </td> + <td> + <div> + <p>The asset to upload.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code>.</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>
