@comapi/sdk-js-foundation

Comapi Javascript SDK - Foundation

Usage no npm install needed!

<script type="module">
  import comapiSdkJsFoundation from 'https://cdn.skypack.dev/@comapi/sdk-js-foundation';
</script>

README

Comapi Javascript SDK - Foundation

Project Structure

├───docs    /* Docs folder */
├───lib     /* 3rd party dependencies */
├───specs   /* tests */
└───src     /* source code */

Install the SDK

The following document details how to install the SDK.

Initialise the SDK

The following document details how to initialise the SDK.

Creating a conversation

The following document details how to create a conversation.

Sending a message to a conversation

The following document details how to send a message to a conversation.

Querying conversations

The following document details how to query conversations.

Querying conversation messages

The following document details how to query messages.

Querying conversation events

The following document details how to query events.

Consuming websocket events

The following document details how to process realtime events that arrive from the websocket.

Posting message status updates

The following document details how to send status updates for a message.

eTag usage

`The following document details how to use eTags and which methods utilise them.

Profile API

The following document details how to use the profile API

Typescript

The following document details how to consume the SDK using typescript.

Cordova

The following document details how to usi the SDK in a cordova Project.