Getting Started

This guide quickly brings you up to speed on Borogove's JavaScript API. The API is flexible and allows you to build any type of chat or messaging.

npm i https://gitpkg-singpolyma.vercel.app/snikket-im/snikket-sdk/npm?compiled

Chat Client

Let's get started by initializing the client and setting the current user and persistence layer:

import * as borogove from "borogove";

// Cache avatars and other media in browser cache
const mediaStore = borogove.persistence.MediaStoreCache("myapp");

// Store chats and history in IndexedDB
const persist = await borogove.persistence.IDB("snikket", mediaStore);

// Create client
const client = new borogove.Client("alice@example.com", persist);

This example is for in the browser, but for other context only the persistence choices will need to change.

Now we need to connect to the server, which must be a Snikket-compatible instance living at example.com, and authenticate the user:

client.addPasswordNeededListener() => {
    client.usePassword("mycoolpassword");
});

client.start();

In real life you probably want to prompt the user when receiving the event. You should not store the password anywhere, as Borogove will handle keeping the user's session token persisted until an explicit logout.

Chats

Let’s continue by starting your first chat. A chat contains messages, a list of people that are participating, and optionally a list of members. The example below shows how to start a chat with a new contact:

const chat = await new Promise(resolve => {
    const search = "hatter@example.com";
    client.findAvailableChats(search, (q, availableChats) => {
        // Check if the results are for our search
        // Allows running searches in parallel as a user types
        if (search !== q) return;

        resolve(client.startChat(availableChats[0]));

        // Stop searching
        return true;
    });
});

findAvailableChats will call the callback with all results found so far, and keep searching until either it has exhausted all options or the callback returns true. Here we just create a promise to resolve to the first chat that is found.

You can always search by the full ID or URI of any chat on the network. Locally known chats will also be returned, as well as any chats from other services configured on the account.

If you have already used a chat before, you can always get it from getChat or list all known chats with getChats.

Messages

Now that we have the chat set up, let's send our first message.

chat.sendMessage(new borogove.ChatMessageBuilder({
    text: "I would like some tea."
}));

Events

This is how you can listen to events:

const onlineEventToken = client.addStatusOnlineListener(() => {
    console.log(`${client.accountId()} is online and in sync`)
});

const messageEventToken = client.addMessageListener((message, eventType) => {
    console.log(`Message ${mesage.text} received or updated`, eventType);
});