textiot

<!DOCTYPE html> <html lang="en"> <head> <title>IpfsApi 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/IpfsApi" class="dashAnchor"></a> <a title="IpfsApi 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" /> IpfsApi 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>IpfsApi</h1> <div class="declaration"> <div class="language"> <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">IpfsApi</span> <span class="p">:</span> <span class="nc">NodeDependant</span></code></pre> </div> </div> <p>Provides access to Textile IPFS 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)IpfsApi(im)peerId:"></a> <a name="//apple_ref/objc/Method/-peerId:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)peerId:">-peerId:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Fetch the IPFS peer 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">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nf">peerId</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">peerId</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> <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>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 IPFS peer id of the local Textile node</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)IpfsApi(im)swarmConnect:error:"></a> <a name="//apple_ref/objc/Method/-swarmConnect:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)swarmConnect:error:">-swarmConnect:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Open a new direct connection to a peer using an IPFS multiaddr</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">BOOL</span><span class="p">)</span><span class="nf">swarmConnect</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">multiaddr</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">swarmConnect</span><span class="p">(</span><span class="n">_</span> <span class="nv">multiaddr</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>multiaddr</em> </code> </td> <td> <div> <p>Peer IPFS multiaddr</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>Whether the peer swarm connect was successfull</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)IpfsApi(im)dataAtPath:completion:"></a> <a name="//apple_ref/objc/Method/-dataAtPath:completion:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)dataAtPath:completion:">-dataAtPath:completion:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Get raw data stored at an IPFS path</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">dataAtPath</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">path</span> <span class="nf">completion</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">NSData</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">completion</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">data</span><span class="p">(</span><span class="n">atPath</span> <span class="nv">path</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Data</span><span class="p">?,</span> <span class="kt">String</span><span class="p">?,</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>path</em> </code> </td> <td> <div> <p>The IPFS path for the data you want to retrieve</p> </div> </td> </tr> <tr> <td> <code> <em>completion</em> </code> </td> <td> <div> <p>A block that will get called with the results of the query</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)IpfsApi(im)pubsubPub:data:error:"></a> <a name="//apple_ref/objc/Method/-pubsubPub:data:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)pubsubPub:data:error:">-pubsubPub:data:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Publishes a message to a given pubsub topic</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">pubsubPub</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">topic</span> <span class="nf">data</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">data</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">pubsubPub</span><span class="p">(</span><span class="n">_</span> <span class="nv">topic</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">data</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>topic</em> </code> </td> <td> <div> <p>The topic to publish to</p> </div> </td> </tr> <tr> <td> <code> <em>data</em> </code> </td> <td> <div> <p>The payload of message to publish</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)IpfsApi(im)pubsubSub:error:"></a> <a name="//apple_ref/objc/Method/-pubsubSub:error:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)pubsubSub:error:">-pubsubSub:error:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Subscribes to messages on a given topic</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">pubsubSub</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">topic</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">pubsubSub</span><span class="p">(</span><span class="n">_</span> <span class="nv">topic</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>topic</em> </code> </td> <td> <div> <p>The ipfs pubsub sub topic</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 query ID that can be used to cancel the sub</p> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:objc(cs)IpfsApi(im)cancelPubsubSub:"></a> <a name="//apple_ref/objc/Method/-cancelPubsubSub:" class="dashAnchor"></a> <a class="token" href="#/c:objc(cs)IpfsApi(im)cancelPubsubSub:">-cancelPubsubSub:</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Cancel subscribe to messages on a given topic</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">cancelPubsubSub</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">queryId</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">cancelPubsubSub</span><span class="p">(</span><span class="n">_</span> <span class="nv">queryId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>queryId</em> </code> </td> <td> <div> <p>The query ID that can be used to cancel the sub</p> </div> </td> </tr> </tbody> </table> </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>