Provides a way to use the Catenis services from within WordPress

IronMan

Catenis Blocks

A set of Gutenberg blocks that make use of Catenis services.

<p>Catenis API Client for WordPress enables (JavaScript) code on WordPress pages to interact with the Catenis API.</p>
<h4>Enabling the Catenis API client</h4>
<p>To enable the Catenis API client for a given WordPress page, go to the page’s edit page and look for a section (meta box) named “Catenis API Client” below the page’s main editing panel. Make sure the section is expanded, and check the <code>Load Catenis API Client</code> checkbox.</p>
<p>You can then choose to override the global settings used for instantiating the Catenis API client on that given page, like using a different device ID and its associated API access secret. Otherwise, whatever is configured in the plugin’s global settings — configured under “Settings” | “Catenis API Client” — is going to be used.</p>
<h4>Using the Catenis API client</h4>
<p>Once enabled, a global JavaScript variable named <code>ctnApiClient</code> is made available on the page. That variable holds the instantiated Catenis API client object.</p>
<p>Use the <em>ctnApiClient</em> variable to call the Catenis API methods by invoking the corresponding method on that object.</p>
<p>For a reference of the available methods, please refer to the <a href="https://github.com/blockchainofthings/CatenisAPIClientJS" rel="nofollow ugc">Catenis API JavaScript Client</a> as it is functionally identical to the Catenis API Client for WordPress, except for notifications support and error handling.</p>
<h4>Notifications support</h4>
<p>The notification feature on Catenis API Client for WordPress is almost identical to the one found on the Catenis API JavaScript client. The two noticeable differences are:</p>
<ol>
<li>The Catenis API client object can emit a <code>comm-error</code> event.</li>
<li>The <code>open</code> event emitted by the WebSocket notification channel object may return an error.</li>
</ol>
<p>Please refer to the “Receiving Notifications” section below for detailed information on how to receive Catenis notifications from within WordPress pages.</p>
<h4>Error handling</h4>
<p>Errors that take place while calling the Catenis API methods are returned as standard JavaScript Error objects.</p>
<h3>Receiving Notifications</h3>
<p>= Instantiate WebSocket notification channel object</p>
<p>Create a WebSocket notification channel for a given Catenis notification event.</p>
<pre><code>var wsNotifyChannel = ctnApiClient.createWsNotifyChannel(eventName);
</code></pre>
<h4>Add listeners</h4>
<p>Add event listeners to monitor activity on the notification channel.</p>
<pre><code>ctnApiClient.on('comm-error', function (error) {
    // Error communicating with Catenis notification process
});

wsNotifyChannel.on('open', function (error) {
    if (error) {
        // Error establishing underlying WebSocket connection
    }
    else {
        // Notification channel successfully open
    }
});

wsNotifyChannel.on('error', function (error) {
    // Error in the underlying WebSocket connection
});

wsNotifyChannel.on('close', function (code, reason) {
    // Underlying WebSocket connection has been closed
});

wsNotifyChannel.on('notify', function (eventData) {
    // Received notification
});
</code></pre>
<blockquote>
<p><strong>Note</strong>: the ‘comm-error’ event is emitted by the Catenis API client object while all other events are emitted by the WebSocket notification channel object.</p>
</blockquote>
<h4>Open the notification channel</h4>
<p>Open the WebSocket notification channel to start receiving notifications.</p>
<pre><code>wsNotifyChannel.open(function (error) {
    if (err) {
        // Error sending command to open notification channel
    }
});
</code></pre>
<h4>Close the notification channel</h4>
<p>Close the WebSocket notification channel to stop receiving notifications.</p>
<pre><code>wsNotifyChannel.close(function (error) {
    if (err) {
        // Error sending command to close notification channel
    }
});
</code></pre>


Alternatives to Catenis API Client for WordPress

Top alternatives