textiot

<!DOCTYPE html> <html lang="en"> <head> <title>ThreadsApi 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/objc/Class/ThreadsApi" class="dashAnchor"></a> <a title="ThreadsApi Class Reference"></a> <header> <div class="content-wrapper"> <p><a href="../index.html">Textile Docs</a> (80% documented)</p> <p class="header-right"><a href="https://github.com/textileio/ios-textile"><img src="../img/gh.png"/>View on GitHub</a></p> </div> </header> <div class="content-wrapper"> <p id="breadcrumbs"> <a href="../index.html">Textile Reference</a> <img id="carat" src="../img/carat.png" /> ThreadsApi 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/AccountApi.html">AccountApi</a> </li> <li class="nav-group-task"> <a href="../Classes/CafesApi.html">CafesApi</a> </li> <li class="nav-group-task"> <a href="../Classes/CommentsApi.html">CommentsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/ContactsApi.html">ContactsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/FeedApi.html">FeedApi</a> </li> <li class="nav-group-task"> <a href="../Classes/FeedItemData.html">FeedItemData</a> </li> <li class="nav-group-task"> <a href="../Classes/FilesApi.html">FilesApi</a> </li> <li class="nav-group-task"> <a href="../Classes/FlagsApi.html">FlagsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/IgnoresApi.html">IgnoresApi</a> </li> <li class="nav-group-task"> <a href="../Classes/InvitesApi.html">InvitesApi</a> </li> <li class="nav-group-task"> <a href="../Classes/IpfsApi.html">IpfsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/LikesApi.html">LikesApi</a> </li> <li class="nav-group-task"> <a href="../Classes/LogsApi.html">LogsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/MessagesApi.html">MessagesApi</a> </li> <li class="nav-group-task"> <a href="../Classes/NotificationsApi.html">NotificationsApi</a> </li> <li class="nav-group-task"> <a href="../Classes/ProfileApi.html">ProfileApi</a> </li> <li class="nav-group-task"> <a href="../Classes/SchemasApi.html">SchemasApi</a> </li> <li class="nav-group-task"> <a href="../Classes/Textile.html">Textile</a> </li> <li class="nav-group-task"> <a href="../Classes/ThreadsApi.html">ThreadsApi</a> </li> </ul> </li> <li class="nav-group-name"> <a href="../Constants.html">Constants</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Constants.html#/c:@TEXTILE_BACKGROUND_SESSION_ID">TEXTILE_BACKGROUND_SESSION_ID</a> </li> </ul> </li> <li class="nav-group-name"> <a href="../Protocols.html">Protocols</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Protocols/TextileDelegate.html">TextileDelegate</a> </li> </ul> </li> <li class="nav-group-name"> <a href="../Type%20Definitions.html">Type Definitions</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Type%20Definitions/FeedItemType.html">FeedItemType</a> </li> </ul> </li> </ul> </nav> <article class="main-content"> <section> <section class="section"> <h1>ThreadsApi</h1> <div class="declaration"> <div class="language"> <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">ThreadsApi</span> <span class="p">:</span> <span class="nc">NodeDependant</span></code></pre> </div> </div> <p>Provides access to Textile threads related APIs</p> </section> <section class="section task-group-section"> <div class="task-group"> <ul> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)add:error:"></a> <a name="//apple_ref/objc/Method/-add:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)add:error:">-add:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Create a new thread</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">add</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">config</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">add</span><span class="p">(</span><span class="n">_</span> <span class="nv">config</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>config</em> </code> </td> <td> <div> <p>The configuration object that describes the thread to be created</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The newly created thread</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)addOrUpdate:error:"></a> <a name="//apple_ref/objc/Method/-addOrUpdate:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)addOrUpdate:error:">-addOrUpdate:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Update an existing thread or create it if it doesn’t exist</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addOrUpdate</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">thrd</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addOrUpdate</span><span class="p">(</span><span class="n">_</span> <span class="nv">thrd</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSErrorPointer</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>thrd</em> </code> </td> <td> <div> <p>The updated representation of the thread to update</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)rename:name:error:"></a> <a name="//apple_ref/objc/Method/-rename:name:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)rename:name:error:">-rename:name:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Rename a thread</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">rename</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">threadId</span> <span class="nf">name</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">rename</span><span class="p">(</span><span class="n">_</span> <span class="nv">threadId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSErrorPointer</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>threadId</em> </code> </td> <td> <div> <p>The id of the thread to rename</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The new name for the thread</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)get:error:"></a> <a name="//apple_ref/objc/Method/-get:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)get:error:">-get:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Get an existing thread by id</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">get</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">threadId</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">get</span><span class="p">(</span><span class="n">_</span> <span class="nv">threadId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>threadId</em> </code> </td> <td> <div> <p>The id of the thread to retrieve</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The corresponding thread object</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)list:"></a> <a name="//apple_ref/objc/Method/-list:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)list:">-list:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>List all threads the local peer account participates in</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">list</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">list</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>An object containing a list of threads</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)peers:error:"></a> <a name="//apple_ref/objc/Method/-peers:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)peers:error:">-peers:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>List all peers that participate in a particular thread</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">peers</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">threadId</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">peers</span><span class="p">(</span><span class="n">_</span> <span class="nv">threadId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>threadId</em> </code> </td> <td> <div> <p>The id of the thread to query</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>An object containing a list of contacts</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)remove:error:"></a> <a name="//apple_ref/objc/Method/-remove:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)remove:error:">-remove:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Leave a thread</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nf">remove</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">threadId</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">remove</span><span class="p">(</span><span class="n">_</span> <span class="nv">threadId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSErrorPointer</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>threadId</em> </code> </td> <td> <div> <p>The id of the thread to remove</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>The hash of the newly created thread leave block</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)snapshot:"></a> <a name="//apple_ref/objc/Method/-snapshot:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)snapshot:">-snapshot:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Snapshot all threads and sync them to registered cafes</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">snapshot</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">snapshot</span><span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSErrorPointer</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)ThreadsApi(im)searchSnapshots:options:error:"></a> <a name="//apple_ref/objc/Method/-searchSnapshots:options:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)ThreadsApi(im)searchSnapshots:options:error:">-searchSnapshots:options:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Searches the network for thread snapshots</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Objective-C</p> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">searchSnapshots</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">query</span> <span class="nf">options</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">options</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> </div> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">searchSnapshots</span><span class="p">(</span><span class="n">_</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>query</em> </code> </td> <td> <div> <p>The object describing the query to execute</p> </div> </td> </tr> <tr> <td> <code> <em>options</em> </code> </td> <td> <div> <p>Options controlling the behavior of the search</p> </div> </td> </tr> <tr> <td> <code> <em>error</em> </code> </td> <td> <div> <p>A reference to an error pointer that will be set in the case of an error</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>A handle that can be used to cancel the search</p> </div> </section> </div> </li> </ul> </div> </section> </section> <section id="footer"> <p>© 2019 <a class="link" href="https://textile.io" target="_blank" rel="external">Textile</a>. All rights reserved. (Last updated: 2019-11-19)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.12.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> </section> </article> </div> </body> </div> </html>