https://github.com/comapi/comapi-sdk-js
JavaScript SDK for Comapi
https://github.com/comapi/comapi-sdk-js
Last synced: 4 months ago
JSON representation
JavaScript SDK for Comapi
- Host: GitHub
- URL: https://github.com/comapi/comapi-sdk-js
- Owner: comapi
- License: mit
- Created: 2017-03-24T11:04:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T10:13:32.000Z (about 2 years ago)
- Last Synced: 2025-08-08T14:50:05.285Z (12 months ago)
- Language: TypeScript
- Size: 1.4 MB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
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](./docs/installation.md) the SDK.
## Initialise the SDK
The following document details how to [initialise](./docs/initialisation.md) the SDK.
## Creating a conversation
The following document details how to create a [conversation](./docs/conversations.md).
## Sending a message to a conversation
The following document details how to [send](./docs/sendMessage.md) a message to a conversation.
## Querying conversations
The following document details how to [query](./docs/queryingConversations.md) conversations.
## Querying conversation messages
The following document details how to query [messages](./docs/queryingMessages.md).
## Querying conversation events
The following document details how to query [events](./docs/queryingEvents.md).
## Consuming websocket events
The following document details how to process realtime [events](./docs/websocketEvents.md) that arrive from the websocket.
## Posting message status updates
The following document details how to send [status updates](./docs/statusUpdates.md) for a message.
## eTag usage
`The following document details how to use [eTags](./docs/eTags.md) and which methods utilise them.
## Profile API
The following document details how to use the [profile](./docs/profile.md) API
## Typescript
The following document details how to consume the SDK using [typescript](./docs/typescript.md).
## Cordova
The following document details how to usi the SDK in a [cordova](./docs/cordova.md) Project.