Skip to content

Commit

Permalink
Version 6.2
Browse files Browse the repository at this point in the history 
Added method to retrieve list of files (Fixes Issue #8). Major improvements to the delete document method (Fixes Issue #7). Fixes spelling issues in documentation.
  • Loading branch information
iRare Media committed Oct 9, 2013
1 parent 8a6bdd4 commit be69e02
Show file tree
Hide file tree
Showing 26 changed files with 253 additions and 118 deletions.
4 changes: 2 additions & 2 deletions Documentation/com.iRareMedia.iCloudSDK.docset/Contents/Info.plist
View file
Expand Up @@ -9,9 +9,9 @@
<key>CFBundleName</key>
<string>iCloudSDK Documentation</string>
<key>CFBundleShortVersionString</key>
<string>6.1</string>
<string>6.2</string>
<key>CFBundleVersion</key>
<string>6.1</string>
<string>6.2</string>



Expand Down
75 changes: 63 additions & 12 deletions ...entation/com.iRareMedia.iCloudSDK.docset/Contents/Resources/Documents/Classes/iCloud.html
View file
Expand Up @@ -6,7 +6,7 @@
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.1 (build 858)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -56,6 +56,8 @@ <h1 class="hideInXcode">iCloud Class Reference</h1>

<option value="//api/name/fileList">&nbsp;&nbsp;&nbsp;&nbsp;+ fileList</option>

<option value="//api/name/getListOfCloudFiles">&nbsp;&nbsp;&nbsp;&nbsp;+ getListOfCloudFiles</option>

<option value="//api/name/previousQueryResults">&nbsp;&nbsp;&nbsp;&nbsp;+ previousQueryResults</option>

<option value="//api/name/query">&nbsp;&nbsp;&nbsp;&nbsp;+ query</option>
Expand Down Expand Up @@ -132,6 +134,8 @@ <h1 class="hideInXcode">iCloud Class Reference</h1>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/fileList">fileList</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getListOfCloudFiles">getListOfCloudFiles</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/previousQueryResults">previousQueryResults</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/query">query</a></span></li>
Expand Down Expand Up @@ -345,6 +349,13 @@ <h3 class="subsubtitle task-title">Getting content from iCloud</h3>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/getListOfCloudFiles">+&nbsp;getListOfCloudFiles</a></code>
<span class="tooltip"><p>Get a list of files stored in iCloud</p></span>
</span>


</li>
</ul>

Expand Down Expand Up @@ -510,7 +521,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>handler</em></dt>
<dd><p>Code block called when a file is successfully deleted from iCloud. The NSError object contains any error information if an error occured, otherwise it will be nil.</p></dd>
<dd><p>Code block called when a file is successfully deleted from iCloud. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -566,7 +577,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>handler</em></dt>
<dd><p>Code block called when a file is successfully deleted from iCloud. The NSError object contains any error information if an error occured, otherwise it will ne nil.</p></dd>
<dd><p>Code block called when a file is successfully deleted from iCloud. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -675,6 +686,47 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>



<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">iCloud.h</code><br />
</div>


</div>

<div class="section-method">
<a name="//api/name/getListOfCloudFiles" title="getListOfCloudFiles"></a>
<h3 class="subsubtitle method-title">getListOfCloudFiles</h3>



<div class="method-subsection brief-description">
<p>Get a list of files stored in iCloud</p>
</div>



<div class="method-subsection method-declaration"><code>+ (NSArray *)getListOfCloudFiles</code></div>





<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>NSArray with a list of all the files currently stored in your app&rsquo;s iCloud Documents directory</p>
</div>











<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">iCloud.h</code><br />
Expand Down Expand Up @@ -860,7 +912,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>handler</em></dt>
<dd><p>Code block called when the document is successfully saved. The completion block passes UIDocument and NSData objects containing the saved document and it&rsquo;s contents in the form of NSData. The NSError object contains any error information if an error occured, otherwise it will ne nil.</p></dd>
<dd><p>Code block called when the document is successfully saved. The completion block passes UIDocument and NSData objects containing the saved document and it&rsquo;s contents in the form of NSData. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

</div>
Expand All @@ -875,7 +927,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<h4 class="method-subtitle">Discussion</h4>
<p>iCloud Document Sync uses UIDocument and NSData to store and manage files. All of the heavy lifting with NSData and UIDocument is handled for you. There&rsquo;s no need to actually create or manage any files, just give iCloud Document Sync your data, and the rest is done for you.</p>

<p>To create a new document or save an exisiting one (close the document), use this method. Below is a code example of how to use it.</p>
<p>To create a new document or save an existing one (close the document), use this method. Below is a code example of how to use it.</p>

<pre><code>[iCloud saveDocumentWithName:@"Name.ext" withContent:[NSData data] withDelegate:self completion:^(UIDocument *cloudDocument, NSData *documentData, NSError *error) {
if (error == nil) {
Expand Down Expand Up @@ -935,7 +987,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>handler</em></dt>
<dd><p>Code block called when the document is successfully saved. The completion block passes UIDocument and NSData objects containing the saved document and it&rsquo;s contents in the form of NSData. The NSError object contains any error information if an error occured, otherwise it will ne nil.</p></dd>
<dd><p>Code block called when the document is successfully saved. The completion block passes UIDocument and NSData objects containing the saved document and it&rsquo;s contents in the form of NSData. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -1032,7 +1084,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>handler</em></dt>
<dd><p>Code block called when files are uploaded to iCloud. The NSError object contains any error information if an error occured, otherwise it will ne nil.</p></dd>
<dd><p>Code block called when files are uploaded to iCloud. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -1083,12 +1135,12 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>repeatingHandler</em></dt>
<dd><p>Code block called after each file is uploaded to iCloud. This block is called everytime a local file is uploaded, therefore it may be called multiple times. The NSError object contains any error information if an error occured, otherwise it will be nil.</p></dd>
<dd><p>Code block called after each file is uploaded to iCloud. This block is called every-time a local file is uploaded, therefore it may be called multiple times. The NSError object contains any error information if an error occurred, otherwise it will be nil.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Code block called after all files have been uploaded to iCloud. This block is only called once at the end of the method, regardless of any successes or failures that may have occured during the upload(s).</p></dd>
<dd><p>Code block called after all files have been uploaded to iCloud. This block is only called once at the end of the method, regardless of any successes or failures that may have occurred during the upload(s).</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -1143,10 +1195,9 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">iCloud Document Sync Project version 6.1. Available on <a href="http://github.com/iRareMedia/iCloudDocumentSync" target="_blank">GitHub</a></span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-08-09)</span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-10-09)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

</div>
</div>
Expand Down
13 changes: 5 additions & 8 deletions .../com.iRareMedia.iCloudSDK.docset/Contents/Resources/Documents/Classes/iCloudDocument.html
View file
Expand Up @@ -6,7 +6,7 @@
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.1 (build 858)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -162,8 +162,7 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/initWithFileURL:">&ndash;&nbsp;initWithFileURL:</a></code>
<span class="tooltip"><pre><code>Initialize a new UIDocument with the specified file path
</code></pre></span>
<span class="tooltip"><p>Initialize a new UIDocument with the specified file path</p></span>
</span>


Expand Down Expand Up @@ -233,8 +232,7 @@ <h3 class="subsubtitle method-title">initWithFileURL:</h3>


<div class="method-subsection brief-description">
<pre><code>Initialize a new UIDocument with the specified file path
</code></pre>
<p>Initialize a new UIDocument with the specified file path</p>
</div>


Expand Down Expand Up @@ -291,10 +289,9 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">iCloud Document Sync Project version 6.1. Available on <a href="http://github.com/iRareMedia/iCloudDocumentSync" target="_blank">GitHub</a></span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-08-09)</span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-10-09)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

</div>
</div>
Expand Down
19 changes: 9 additions & 10 deletions ...om.iRareMedia.iCloudSDK.docset/Contents/Resources/Documents/Protocols/iCloudDelegate.html
View file
Expand Up @@ -6,7 +6,7 @@
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.1 (build 858)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -195,14 +195,14 @@ <h3 class="subsubtitle task-title">Deprecated Delegate Methods</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/iCloudError:">&ndash;&nbsp;iCloudError:</a></code>
<span class="tooltip"><p>DEPRECATED. Called when there is an error while performing an <a href="../Classes/iCloud.html">iCloud</a> process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.1. use the NSError parameter available in corresponding methods' compeltion handlers.</span>)</p></span>
<span class="tooltip"><p>DEPRECATED. Called when there is an error while performing an <a href="../Classes/iCloud.html">iCloud</a> process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.1. use the NSError parameter available in corresponding methods' completion handlers.</span>)</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/cloudError:">&ndash;&nbsp;cloudError:</a></code>
<span class="tooltip"><p>DEPRECATED. Tells the delegate that there was an error while performing a process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.0. Use the NSError parameter available in corresponding methods' compeltion handlers.</span>)</p></span>
<span class="tooltip"><p>DEPRECATED. Tells the delegate that there was an error while performing a process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.0. Use the NSError parameter available in corresponding methods' completion handlers.</span>)</p></span>
</span>


Expand Down Expand Up @@ -279,7 +279,7 @@ <h3 class="subsubtitle method-title">cloudError:</h3>


<div class="method-subsection brief-description">
<p>DEPRECATED. Tells the delegate that there was an error while performing a process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.0. Use the NSError parameter available in corresponding methods' compeltion handlers.</span>)</p>
<p>DEPRECATED. Tells the delegate that there was an error while performing a process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.0. Use the NSError parameter available in corresponding methods' completion handlers.</span>)</p>
</div>


Expand All @@ -293,7 +293,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>error</em></dt>
<dd><p>Returns the NSError that occured</p></dd>
<dd><p>Returns the NSError that occurred</p></dd>
</dl>

</div>
Expand Down Expand Up @@ -592,7 +592,7 @@ <h3 class="subsubtitle method-title">iCloudError:</h3>


<div class="method-subsection brief-description">
<p>DEPRECATED. Called when there is an error while performing an <a href="../Classes/iCloud.html">iCloud</a> process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.1. use the NSError parameter available in corresponding methods' compeltion handlers.</span>)</p>
<p>DEPRECATED. Called when there is an error while performing an <a href="../Classes/iCloud.html">iCloud</a> process (<b class="deprecated">Deprecated:</b><span class="deprecated"> Deprecated in version 6.1. use the NSError parameter available in corresponding methods' completion handlers.</span>)</p>
</div>


Expand Down Expand Up @@ -670,7 +670,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>

<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>When both files have the same modfication date and file content, <a href="../Classes/iCloud.html">iCloud</a> Document Sync will not be able to automatically determine how to handle the conflict. As a result, this delegate method is called to pass the file information to the delegate which should be able to appropriately handle and resolve the conflict. The delegate should, if needed, present the user with a conflict resolution interface. <a href="../Classes/iCloud.html">iCloud</a> Document Sync does not need to know the result of the attempted resolution, it will continue to upload all files which are not conflicting. It is important to note that <strong>this method may be called more than once in a very short period of time</strong> - be prepared to handle the data appropriately. This delegate method is called on the main thread using GCD.</p>
<p>When both files have the same modification date and file content, <a href="../Classes/iCloud.html">iCloud</a> Document Sync will not be able to automatically determine how to handle the conflict. As a result, this delegate method is called to pass the file information to the delegate which should be able to appropriately handle and resolve the conflict. The delegate should, if needed, present the user with a conflict resolution interface. <a href="../Classes/iCloud.html">iCloud</a> Document Sync does not need to know the result of the attempted resolution, it will continue to upload all files which are not conflicting. It is important to note that <strong>this method may be called more than once in a very short period of time</strong> - be prepared to handle the data appropriately. This delegate method is called on the main thread using GCD.</p>
</div>


Expand Down Expand Up @@ -751,10 +751,9 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">iCloud Document Sync Project version 6.1. Available on <a href="http://github.com/iRareMedia/iCloudDocumentSync" target="_blank">GitHub</a></span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-08-09)</span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-10-09)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

</div>
</div>
Expand Down
11 changes: 5 additions & 6 deletions Documentation/com.iRareMedia.iCloudSDK.docset/Contents/Resources/Documents/hierarchy.html
View file
Expand Up @@ -5,7 +5,7 @@
<title>iCloudSDK Hierarchy</title>
<link rel="stylesheet" type="text/css" href="css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.1 (build 858)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand All @@ -15,7 +15,7 @@ <h1><a id="libraryTitle" href="index.html">iCloudSDK </a></h1>
</div>

<div id="title" role="banner">
<h1 class="hideInXcode">iCloud SDK Hierarchy</h1>
<h1 class="hideInXcode">iCloudSDK Hierarchy</h1>
</div>
<ul id="headerButtons" role="toolbar"></ul>
</header>
Expand All @@ -26,7 +26,7 @@ <h1 class="hideInXcode">iCloud SDK Hierarchy</h1>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">iCloud SDK Hierarchy</h1>
<h1 class="title title-header">iCloudSDK Hierarchy</h1>
</div>
</div>
<div id="container">
Expand Down Expand Up @@ -77,10 +77,9 @@ <h2 class="index-title">Protocol References</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">iCloud Document Sync Project version 6.1. Available on <a href="http://github.com/iRareMedia/iCloudDocumentSync" target="_blank">GitHub</a></span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-08-09)</span><br />
<p><span class="copyright">&copy; 2013 iRare Media. All rights reserved. (Last updated: 2013-10-09)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>


</div>
Expand Down
Binary file modified ...dia.iCloudSDK.docset/Contents/Resources/Documents/img/button_bar_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...eMedia.iCloudSDK.docset/Contents/Resources/Documents/img/library_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...areMedia.iCloudSDK.docset/Contents/Resources/Documents/img/title_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be69e02

Please sign in to comment.