@inconvo/chat-client v3.13.3

Inconvo chat client

Loads an Inconvo chat on any website.

Installation

npm install @inconvo/chat-client

Usage

Import library

import * as inconvoChat from '@inconvo/chat-client';
//or
const inconvoChat = require('@inconvo/chat-client');

Create client

//synchronously
await inconvoChat.createClient({
    appCode: '{app-code}',
});

//or asynchronously
inconvoChat
    .createClient({
        appCode: '{app-code}',
    })
    .then(() => {
        console.log('loaded');
    });

Start a convo

yc.startChat({
    channel: 'channel-slug',
    convo: 'convo-id',
});

or

<button onclick="yc.startChat({channel: 'channel-slug', convo: 'convo-id'})">Start Convo</button>

Subscribe to an event

chatWidget.addEventListener('openLink', (action) => {});

Unsubscribe from an event

chatWidget.removeEventListener('openLink', (action) => {});

API

createClient({options})

Creates a chat client.

options

events

startChat({options})

Opens a chat window.

options

* if a topic is provided in the createClient method, channel won't be mandatory

setConvo({options})

Sets the client channel/convo. This is useful for the floating mode.

options

changeMode(mode)

Changes the mode at runtime.

options

getConvosByTopic

This method returns with an array of convos filtered by topic id and country code.

usage

import { getConvosByTopic } from  "@inconvo/chat-client";

const convos = await getConvosByTopic('topic-id', 'country-code');

parameters